org.LexGrid.LexBIG.cagrid.adapters
Class LexBIGServiceConvenienceMethodsAdapter

java.lang.Object
  extended by org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceConvenienceMethodsAdapter
All Implemented Interfaces:
java.io.Serializable, Extendable, GenericExtension, LexBIGServiceConvenienceMethods

public class LexBIGServiceConvenienceMethodsAdapter
extends java.lang.Object
implements LexBIGServiceConvenienceMethods

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.LexGrid.LexBIG.Extensions.Generic.LexBIGServiceConvenienceMethods
LexBIGServiceConvenienceMethods.HierarchyPathResolveOption
 
Constructor Summary
LexBIGServiceConvenienceMethodsAdapter(LexBIGServiceConvenienceMethodsGridAdapter adapter)
           
 
Method Summary
 void addEntityLuceneIndexes(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.util.List<java.lang.String> arg2)
          Add LuceneIndexes for the given list of concept.
 CodedNodeSet createCodeNodeSet(java.lang.String[] conceptCodes, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Create a CodedNodeSet from a set of concept codes in a coding scheme.
 java.lang.String getAssociationCodeFromAssociationName(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2)
          Return the Association Entity Code given an Association Name.
 java.lang.String[] getAssociationForwardAndReverseNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Return all the association forward name and reverse name for the coding scheme.
 java.lang.String getAssociationForwardName(java.lang.String association, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Return the forward name for the identified association.
 java.lang.String[] getAssociationForwardNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Return all the association forward name for the coding scheme.
 Association getAssociationForwardOneLevel(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3, CodingSchemeVersionOrTag arg4, boolean arg5, NameAndValueList arg6)
          Return a representation of the association between the concepts with the given code in the forward direction of the association in the specified relation containerName.
 java.lang.String[] getAssociationNameForDirectionalName(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2)
          Gets the association names that contain a directional name.
 java.lang.String getAssociationNameFromAssociationCode(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2)
          Return the Association Name given an Association Entity Code.
 java.lang.String getAssociationReverseName(java.lang.String association, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Return the reverse name for the identified association.
 java.lang.String[] getAssociationReverseNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Return all the association reverse name for the coding scheme.
 Association getAssociationReverseOneLevel(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3, CodingSchemeVersionOrTag arg4, boolean arg5, NameAndValueList arg6)
          Return a representation of the association between the concepts with the given code in the reverse direction of the association in the specified relation containerName.
 java.lang.String getCodingSchemeCopyright(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Return the copyright text for the coding scheme.
 CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(java.lang.String associationName)
          Return the coding schemes who supported association matching with associationName.
 java.lang.String getDescription()
          Return a description of the extension.
 java.lang.String getEntityDescription(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String code)
          Returns the entity description for the given code.
 java.lang.String[] getHierarchyIDs(java.lang.String codingScheme, CodingSchemeVersionOrTag csvt)
          Returns the identifiers for hierarchical relationships available for navigation within a coding scheme.
 AssociationList getHierarchyLevelNext(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2, java.lang.String arg3, boolean arg4, boolean arg5, NameAndValueList arg6)
          Return a representation of associations between a concept and its immediate descendants.
 AssociationList getHierarchyLevelNext(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, NameAndValueList associationQualifiers)
          Return a representation of associations between a concept and its immediate descendants.
 int getHierarchyLevelNextCount(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2, ConceptReference arg3)
          Return a count of the number of concepts at the next level in the hierarchy.
 ConceptReferenceList getHierarchyLevelNextCount(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2, ConceptReferenceList arg3)
          Returns a ConceptReferenceList of CountConceptReference that holds the count of concepts at the next level in the hierarchy.
 AssociationList getHierarchyLevelPrev(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2, java.lang.String arg3, boolean arg4, boolean arg5, NameAndValueList arg6)
          Return a representation of associations between a concept and its immediate ancestor(s).
 AssociationList getHierarchyLevelPrev(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, NameAndValueList associationQualifiers)
          Return a representation of associations between a concept and its immediate ancestor(s).
 int getHierarchyLevelPrevCount(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2, ConceptReference arg3)
          Return a count of the number of concepts at the previous level in the hierarchy.
 ConceptReferenceList getHierarchyLevelPrevCount(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2, ConceptReferenceList arg3)
          Returns a ConceptReferenceList of CountConceptReference that holds the count of concepts at the previous level in the hierarchy.
 ResolvedConceptReferenceList getHierarchyOrphanedConcepts(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2)
          Returns all concepts that can not be reached by traversing the hierarchy specified by the hierarchyId from the root.
 AssociationList getHierarchyPathToRoot(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, LexBIGServiceConvenienceMethods.HierarchyPathResolveOption pathResolveOption, NameAndValueList associationQualifiers)
          Return a representation of associations between a concept and hierarchical root node(s).
 ResolvedConceptReferenceList getHierarchyRoots(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID)
          Returns all root nodes for the given hierarchy and coding scheme.
 ResolvedConceptReferenceList getHierarchyRoots(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2, boolean arg3)
          Returns all root nodes for the given hierarchy and coding scheme.
 CodedNodeSet getHierarchyRootSet(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID)
          Returns all root nodes for the given hierarchy as a CodeNodeSet, which can be further restricted.
 LexBIGService getLexBIGService()
           
 java.lang.String getName()
          Return the name assigned to this service extension.
 ResolvedConceptReference getNodesPath(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2, java.lang.String arg3, java.lang.String arg4, java.lang.String arg5, java.lang.String arg6, java.lang.String arg7)
          Return the path/transitive closure path between two nodes.
 java.lang.String getProvider()
          Return an identifier for the extension provider.
 CodingSchemeRendering getRenderingDetail(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Return detailed rendering information (including coding scheme summary, version and status information, reference links, etc) for the given coding scheme; null if not available.
 SupportedHierarchy[] getSupportedHierarchies(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.lang.String arg2)
          Returns an array of hierarchies supported by the given coding scheme and matching the specified ID.
 java.util.List<SupportedProperty> getSupportedPropertiesOfTypeComment(java.lang.String arg0, CodingSchemeVersionOrTag arg1)
          Returns an list of properties supported with propertyType of 'comment'.
 java.util.List<SupportedProperty> getSupportedPropertiesOfTypeDefinition(java.lang.String arg0, CodingSchemeVersionOrTag arg1)
          Returns an list of properties supported with propertyType of 'definition'.
 java.util.List<SupportedProperty> getSupportedPropertiesOfTypePresentation(java.lang.String arg0, CodingSchemeVersionOrTag arg1)
          Returns an list of properties supported with propertyType of 'presentation'.
 java.util.List<SupportedProperty> getSupportedPropertiesOfTypeProperty(java.lang.String arg0, CodingSchemeVersionOrTag arg1)
          Returns an list of properties supported with propertyType of 'property'.
 java.lang.String getVersion()
          Return version information about the extension.
 boolean isCodeRetired(java.lang.String conceptCode, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag)
          Indicates if the given code is considered retired or inactive within context of the provided scheme.
 boolean isForwardName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String directionalName)
          Return true if directionalName is the forward name of an association for the coding scheme.
 boolean isReverseName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String directionalName)
          Return true if directionalName is the reverse name of an association for the coding scheme.
 void modifyEntityLuceneIndexes(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.util.List<java.lang.String> arg2)
          Modify LuceneIndexes for the given list of concept.
 void removeEntityLuceneIndexes(java.lang.String arg0, CodingSchemeVersionOrTag arg1, java.util.List<java.lang.String> arg2)
          Remove LuceneIndexes for the given list of concept.
 void setLexBIGService(LexBIGService arg0)
          Assign the associated LexBIGService instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LexBIGServiceConvenienceMethodsAdapter

public LexBIGServiceConvenienceMethodsAdapter(LexBIGServiceConvenienceMethodsGridAdapter adapter)
                                       throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException
Method Detail

getRenderingDetail

public CodingSchemeRendering getRenderingDetail(java.lang.String codingScheme,
                                                CodingSchemeVersionOrTag versionOrTag)
                                         throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return detailed rendering information (including coding scheme summary, version and status information, reference links, etc) for the given coding scheme; null if not available.

Specified by:
getRenderingDetail in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException

getCodingSchemesWithSupportedAssociation

public CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(java.lang.String associationName)
                                                                   throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return the coding schemes who supported association matching with associationName. The search is performed only for loaded coding schemes.

Specified by:
getCodingSchemesWithSupportedAssociation in interface LexBIGServiceConvenienceMethods
Parameters:
associationName - Association name to search for. It is case sensitive.
Returns:
List of coding schemes who has supported association matching with the value of associationName
Throws:
LBException

getHierarchyIDs

public java.lang.String[] getHierarchyIDs(java.lang.String codingScheme,
                                          CodingSchemeVersionOrTag csvt)
                                   throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns the identifiers for hierarchical relationships available for navigation within a coding scheme. These identifiers can be submitted to the getHierarchyBroader() or getHierarchyNarrower() methods to navigate corresponding tree structures.

Possible return values are defined by the LexBIG model (see http://informatics.mayo.edu/LexGrid/downloads/LexGrid%20Model/ schemas/2008/01/EAwebpublish/index.htm).

Specified by:
getHierarchyIDs in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
csvt - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The array of identifiers; empty if no hierarchies are explicitly defined (the ontology is 'flat').
Throws:
LBException

getDescription

public java.lang.String getDescription()
Description copied from interface: Extendable
Return a description of the extension.

Specified by:
getDescription in interface Extendable

getName

public java.lang.String getName()
Description copied from interface: Extendable
Return the name assigned to this service extension. This name must be unique within context of the installed node and is used to register and lookup the extension through a LexBIGService.

Specified by:
getName in interface Extendable

getProvider

public java.lang.String getProvider()
Description copied from interface: Extendable
Return an identifier for the extension provider.

Specified by:
getProvider in interface Extendable

getVersion

public java.lang.String getVersion()
Description copied from interface: Extendable
Return version information about the extension.

Specified by:
getVersion in interface Extendable

createCodeNodeSet

public CodedNodeSet createCodeNodeSet(java.lang.String[] conceptCodes,
                                      java.lang.String codingScheme,
                                      CodingSchemeVersionOrTag versionOrTag)
                               throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Create a CodedNodeSet from a set of concept codes in a coding scheme.

Specified by:
createCodeNodeSet in interface LexBIGServiceConvenienceMethods
Parameters:
conceptCodes - The concept codes for included items.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
A CodedNodeSet representing the corresponding coded entries.
Throws:
LBException

getAssociationForwardAndReverseNames

public java.lang.String[] getAssociationForwardAndReverseNames(java.lang.String codingScheme,
                                                               CodingSchemeVersionOrTag versionOrTag)
                                                        throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return all the association forward name and reverse name for the coding scheme.

Specified by:
getAssociationForwardAndReverseNames in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException

getAssociationForwardName

public java.lang.String getAssociationForwardName(java.lang.String association,
                                                  java.lang.String codingScheme,
                                                  CodingSchemeVersionOrTag versionOrTag)
                                           throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return the forward name for the identified association.

Specified by:
getAssociationForwardName in interface LexBIGServiceConvenienceMethods
Parameters:
association - Primary name of the association.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException

getAssociationForwardNames

public java.lang.String[] getAssociationForwardNames(java.lang.String codingScheme,
                                                     CodingSchemeVersionOrTag versionOrTag)
                                              throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return all the association forward name for the coding scheme.

Specified by:
getAssociationForwardNames in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException

getAssociationReverseName

public java.lang.String getAssociationReverseName(java.lang.String association,
                                                  java.lang.String codingScheme,
                                                  CodingSchemeVersionOrTag versionOrTag)
                                           throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return the reverse name for the identified association.

Specified by:
getAssociationReverseName in interface LexBIGServiceConvenienceMethods
Parameters:
association - Basic (non-directional) name of the association.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException

getAssociationReverseNames

public java.lang.String[] getAssociationReverseNames(java.lang.String codingScheme,
                                                     CodingSchemeVersionOrTag versionOrTag)
                                              throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return all the association reverse name for the coding scheme.

Specified by:
getAssociationReverseNames in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException

getHierarchyLevelNext

public AssociationList getHierarchyLevelNext(java.lang.String codingScheme,
                                             CodingSchemeVersionOrTag versionOrTag,
                                             java.lang.String hierarchyID,
                                             java.lang.String conceptCode,
                                             boolean resolveConcepts,
                                             NameAndValueList associationQualifiers)
                                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a representation of associations between a concept and its immediate descendants. The resolved association list represents the next branch of the hierarchy when visualized in a top (root) to bottom (leaf) representation. This method checks for the existence of a path to root and is equivalent to calling getHierarchyLevelNext with checkForHasHierarchyPathToRoot set to true.

Specified by:
getHierarchyLevelNext in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
hierarchyID - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
conceptCode - The starting point for resolution; not null.
resolveConcepts - True to fill in all information for concepts identified as part of the returned association; false to return only basic references (e.g. code, coding scheme, and description). If false, additional properties for referenced concepts can be resolved on an item-by-item basis as controlled by the application.
associationQualifiers - Restrict to associations with specific qualifiers (e.g. associations might be tagged with source-specific information); null or empty to ignore qualifications.
Returns:
The list of associations and referenced concepts representing immediate descendant within the hierarchy; empty if no items are found.
Throws:
LBException

getHierarchyLevelPrev

public AssociationList getHierarchyLevelPrev(java.lang.String codingScheme,
                                             CodingSchemeVersionOrTag versionOrTag,
                                             java.lang.String hierarchyID,
                                             java.lang.String conceptCode,
                                             boolean resolveConcepts,
                                             NameAndValueList associationQualifiers)
                                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a representation of associations between a concept and its immediate ancestor(s). The resolved association list represents the previous level of the hierarchy when visualized in a top (root) to bottom (leaf) representation. This method checks for the existence of a path to root and is equivalent to calling getHierarchyLevelPrev with checkForHasHierarchyPathToRoot set to true. The check slows down the computation.

Specified by:
getHierarchyLevelPrev in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
hierarchyID - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
conceptCode - The starting point for resolution; not null.
resolveConcepts - True to fill in all information for concepts identified as part of the returned association; false to return only basic references (e.g. code, coding scheme, and description). If false, additional properties for referenced concepts can be resolved on an item-by-item basis as controlled by the application.
associationQualifiers - Restrict to associations with specific qualifiers (e.g. associations might be tagged with source-specific information); null or empty to ignore qualifications.
Returns:
The list of associations and referenced concepts representing the immediate ancestor(s) within the hierarchy; empty if no items are found.
Throws:
LBException

getHierarchyPathToRoot

public AssociationList getHierarchyPathToRoot(java.lang.String codingScheme,
                                              CodingSchemeVersionOrTag versionOrTag,
                                              java.lang.String hierarchyID,
                                              java.lang.String conceptCode,
                                              boolean resolveConcepts,
                                              LexBIGServiceConvenienceMethods.HierarchyPathResolveOption pathResolveOption,
                                              NameAndValueList associationQualifiers)
                                       throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a representation of associations between a concept and hierarchical root node(s). The resolved association list represents the path within the hierarchy from traversed from bottom (leaf) to top (root).

Specified by:
getHierarchyPathToRoot in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
hierarchyID - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
conceptCode - The starting point for resolution; not null.
resolveConcepts - True to fill in all information for concepts identified as part of the returned association; false to return only basic references (e.g. code, coding scheme, and description). If false, additional properties for referenced concepts can be resolved on an item-by-item basis as controlled by the application.
pathResolveOption - It is possible that more than one path can exist between the conceptCode and hierarchy roots by navigating different intermediate nodes. This parameter allows the number of returned paths to be constrained.
associationQualifiers - Restrict to associations with specific qualifiers (e.g. associations might be tagged with source-specific information); null or empty to ignore qualifications.
Returns:
The list of associations and referenced concepts representing the path to root node(s) within the hierarchy; empty if no items are found. If not empty, each association in the initial list represents a separate path to root for the given concept.
Throws:
LBException

getHierarchyRoots

public ResolvedConceptReferenceList getHierarchyRoots(java.lang.String codingScheme,
                                                      CodingSchemeVersionOrTag versionOrTag,
                                                      java.lang.String hierarchyID)
                                               throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns all root nodes for the given hierarchy and coding scheme. Each root concept represents the conceptual start or narrowest point of a tree when visualizing the hierarchy.

Specified by:
getHierarchyRoots in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
hierarchyID - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, roots for all registered hierarchies are returned.
Returns:
The collection of references to root nodes; empty if the given hierarchy is not recognized or is unfulfilled by the given coding scheme and version.
Throws:
LBException

getHierarchyRootSet

public CodedNodeSet getHierarchyRootSet(java.lang.String codingScheme,
                                        CodingSchemeVersionOrTag versionOrTag,
                                        java.lang.String hierarchyID)
                                 throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns all root nodes for the given hierarchy as a CodeNodeSet, which can be further restricted. Each root concept represents the conceptual start or narrowest point of a tree when visualizing the hierarchy.

Specified by:
getHierarchyRootSet in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
hierarchyID - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, roots for all registered hierarchies are returned.
Returns:
The collection of references to root nodes; empty if the given hierarchy is not recognized or is unfulfilled by the given coding scheme and version.
Throws:
LBException

isForwardName

public boolean isForwardName(java.lang.String codingScheme,
                             CodingSchemeVersionOrTag versionOrTag,
                             java.lang.String directionalName)
                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return true if directionalName is the forward name of an association for the coding scheme.

Specified by:
isForwardName in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
directionalName - The directionalName string
Throws:
LBException

isReverseName

public boolean isReverseName(java.lang.String codingScheme,
                             CodingSchemeVersionOrTag versionOrTag,
                             java.lang.String directionalName)
                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return true if directionalName is the reverse name of an association for the coding scheme.

Specified by:
isReverseName in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
directionalName - The directionalName string
Throws:
LBException

isCodeRetired

public boolean isCodeRetired(java.lang.String conceptCode,
                             java.lang.String codingScheme,
                             CodingSchemeVersionOrTag versionOrTag)
                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Indicates if the given code is considered retired or inactive within context of the provided scheme.

Specified by:
isCodeRetired in interface LexBIGServiceConvenienceMethods
Parameters:
conceptCode - The concept code to evaluate.
codingScheme - The local name or URN of the coding scheme to query.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme to query.
Returns:
true if retired; false otherwise
Throws:
LBException

getCodingSchemeCopyright

public java.lang.String getCodingSchemeCopyright(java.lang.String codingScheme,
                                                 CodingSchemeVersionOrTag versionOrTag)
                                          throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return the copyright text for the coding scheme.

Specified by:
getCodingSchemeCopyright in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException

getLexBIGService

public LexBIGService getLexBIGService()
Specified by:
getLexBIGService in interface LexBIGServiceConvenienceMethods
Returns:
LexBIGService Return the associated LexBIGService instance; lazy initialized as required.

setLexBIGService

public void setLexBIGService(LexBIGService arg0)
Description copied from interface: LexBIGServiceConvenienceMethods
Assign the associated LexBIGService instance.

Note: This method must be invoked by users of the distributed LexBIG API to set the service to an EVSApplicationService object, allowing client side implementations to use these convenience methods.

Specified by:
setLexBIGService in interface LexBIGServiceConvenienceMethods

getEntityDescription

public java.lang.String getEntityDescription(java.lang.String codingScheme,
                                             CodingSchemeVersionOrTag versionOrTag,
                                             java.lang.String code)
                                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns the entity description for the given code.

Specified by:
getEntityDescription in interface LexBIGServiceConvenienceMethods
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
code - The code to resolve.
Returns:
The entity description associated with the code, or null if not available.
Throws:
LBException

getAssociationForwardOneLevel

public Association getAssociationForwardOneLevel(java.lang.String arg0,
                                                 java.lang.String arg1,
                                                 java.lang.String arg2,
                                                 java.lang.String arg3,
                                                 CodingSchemeVersionOrTag arg4,
                                                 boolean arg5,
                                                 NameAndValueList arg6)
                                          throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a representation of the association between the concepts with the given code in the forward direction of the association in the specified relation containerName.

Specified by:
getAssociationForwardOneLevel in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - The conceptCode to lookup.
arg1 - The relations container to query. If null, the native relations container for the code system will be assumed.
arg2 - Local name of the specific relation/association to evaluate ("hasSubtype", etc).
arg3 - The local name or URN of the coding scheme to query.
arg4 - The assigned tag/label or absolute version identifier of the coding scheme.
arg5 - true to resolve the full concept codes, false for skeletons
arg6 - Restrict to associations with specific qualifiers, for example from a specific source
Throws:
LBException

getAssociationReverseOneLevel

public Association getAssociationReverseOneLevel(java.lang.String arg0,
                                                 java.lang.String arg1,
                                                 java.lang.String arg2,
                                                 java.lang.String arg3,
                                                 CodingSchemeVersionOrTag arg4,
                                                 boolean arg5,
                                                 NameAndValueList arg6)
                                          throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a representation of the association between the concepts with the given code in the reverse direction of the association in the specified relation containerName.

Specified by:
getAssociationReverseOneLevel in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - ConceptCode to lookup.
arg1 - The relations container to query. If null, the native relations container for the code system will be assumed.
arg2 - Local name of the specific relation/association to evaluate ("hasSubtype", etc).
arg3 - The local name or URN of the coding scheme to query.
arg4 - The assigned tag/label or absolute version identifier of the coding scheme.
arg5 - true to resolve the full concept codes, false for skeletons
arg6 - Restrict to associations with specific qualifiers, for example from a specific source
Throws:
LBException

addEntityLuceneIndexes

public void addEntityLuceneIndexes(java.lang.String arg0,
                                   CodingSchemeVersionOrTag arg1,
                                   java.util.List<java.lang.String> arg2)
                            throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Add LuceneIndexes for the given list of concept.

Specified by:
addEntityLuceneIndexes in interface LexBIGServiceConvenienceMethods
Throws:
LBException

getHierarchyLevelNext

public AssociationList getHierarchyLevelNext(java.lang.String arg0,
                                             CodingSchemeVersionOrTag arg1,
                                             java.lang.String arg2,
                                             java.lang.String arg3,
                                             boolean arg4,
                                             boolean arg5,
                                             NameAndValueList arg6)
                                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a representation of associations between a concept and its immediate descendants. The resolved association list represents the next branch of the hierarchy when visualized in a top (root) to bottom (leaf) representation. This method allows for a boolean flag checkForHasHierarchyPathToRoot to be passed in.

Specified by:
getHierarchyLevelNext in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - The local name or URN of the coding scheme.
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
arg3 - The starting point for resolution; not null.
arg4 - True to fill in all information for concepts identified as part of the returned association; false to return only basic references (e.g. code, coding scheme, and description). If false, additional properties for referenced concepts can be resolved on an item-by-item basis as controlled by the application.
arg5 - True checks for the existence of a path from the concept to the root. This check slows down the processing as hierarchy checks have to be made. If no path is found, the method returns an empty AssociationList
arg6 - Restrict to associations with specific qualifiers (e.g. associations might be tagged with source-specific information); null or empty to ignore qualifications.
Returns:
The list of associations and referenced concepts representing immediate descendant within the hierarchy; empty if no items are found.
Throws:
LBException

getHierarchyLevelNextCount

public int getHierarchyLevelNextCount(java.lang.String arg0,
                                      CodingSchemeVersionOrTag arg1,
                                      java.lang.String arg2,
                                      ConceptReference arg3)
                               throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a count of the number of concepts at the next level in the hierarchy.

Specified by:
getHierarchyLevelNextCount in interface LexBIGServiceConvenienceMethods
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
arg3 - The starting point for resolution; not null.
Returns:
The number of concepts at the next level
Throws:
LBException

getHierarchyLevelNextCount

public ConceptReferenceList getHierarchyLevelNextCount(java.lang.String arg0,
                                                       CodingSchemeVersionOrTag arg1,
                                                       java.lang.String arg2,
                                                       ConceptReferenceList arg3)
                                                throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns a ConceptReferenceList of CountConceptReference that holds the count of concepts at the next level in the hierarchy.

Specified by:
getHierarchyLevelNextCount in interface LexBIGServiceConvenienceMethods
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
Returns:
ConceptReferenceList of CountConceptReference that holds the count
Throws:
LBException

getHierarchyLevelPrev

public AssociationList getHierarchyLevelPrev(java.lang.String arg0,
                                             CodingSchemeVersionOrTag arg1,
                                             java.lang.String arg2,
                                             java.lang.String arg3,
                                             boolean arg4,
                                             boolean arg5,
                                             NameAndValueList arg6)
                                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a representation of associations between a concept and its immediate ancestor(s). The resolved association list represents the previous level of the hierarchy when visualized in a top (root) to bottom (leaf) representation. This method allows for a boolean flag checkForHasHierarchyPathToRoot to be passed in.

Specified by:
getHierarchyLevelPrev in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - The local name or URN of the coding scheme.
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
arg3 - The starting point for resolution; not null.
arg4 - True to fill in all information for concepts identified as part of the returned association; false to return only basic references (e.g. code, coding scheme, and description). If false, additional properties for referenced concepts can be resolved on an item-by-item basis as controlled by the application.
arg5 - True checks for the existence of a path from the concept to the root. This check slows down the processing as hierarchy checks have to be made.
arg6 - Restrict to associations with specific qualifiers (e.g. associations might be tagged with source-specific information); null or empty to ignore qualifications.
Returns:
The list of associations and referenced concepts representing the immediate ancestor(s) within the hierarchy; empty if no items are found.
Throws:
LBException

getHierarchyLevelPrevCount

public int getHierarchyLevelPrevCount(java.lang.String arg0,
                                      CodingSchemeVersionOrTag arg1,
                                      java.lang.String arg2,
                                      ConceptReference arg3)
                               throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return a count of the number of concepts at the previous level in the hierarchy.

Specified by:
getHierarchyLevelPrevCount in interface LexBIGServiceConvenienceMethods
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
arg3 - The starting point for resolution; not null.
Returns:
The number of concepts at the previous level
Throws:
LBException

getHierarchyLevelPrevCount

public ConceptReferenceList getHierarchyLevelPrevCount(java.lang.String arg0,
                                                       CodingSchemeVersionOrTag arg1,
                                                       java.lang.String arg2,
                                                       ConceptReferenceList arg3)
                                                throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns a ConceptReferenceList of CountConceptReference that holds the count of concepts at the previous level in the hierarchy.

Specified by:
getHierarchyLevelPrevCount in interface LexBIGServiceConvenienceMethods
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, associations for all registered hierarchies are navigated (less precise, but improves performance).
Returns:
ConceptReferenceList of CountConceptReference that holds the count
Throws:
LBException

getSupportedHierarchies

public SupportedHierarchy[] getSupportedHierarchies(java.lang.String arg0,
                                                    CodingSchemeVersionOrTag arg1,
                                                    java.lang.String arg2)
                                             throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns an array of hierarchies supported by the given coding scheme and matching the specified ID. If the ID is null, return all registered hierarchies (any ID).

Specified by:
getSupportedHierarchies in interface LexBIGServiceConvenienceMethods
Returns:
SupportedHierarchy
Throws:
LBException

modifyEntityLuceneIndexes

public void modifyEntityLuceneIndexes(java.lang.String arg0,
                                      CodingSchemeVersionOrTag arg1,
                                      java.util.List<java.lang.String> arg2)
                               throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Modify LuceneIndexes for the given list of concept.

Specified by:
modifyEntityLuceneIndexes in interface LexBIGServiceConvenienceMethods
Throws:
LBException

removeEntityLuceneIndexes

public void removeEntityLuceneIndexes(java.lang.String arg0,
                                      CodingSchemeVersionOrTag arg1,
                                      java.util.List<java.lang.String> arg2)
                               throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Remove LuceneIndexes for the given list of concept.

Specified by:
removeEntityLuceneIndexes in interface LexBIGServiceConvenienceMethods
Throws:
LBException

getAssociationCodeFromAssociationName

public java.lang.String getAssociationCodeFromAssociationName(java.lang.String arg0,
                                                              CodingSchemeVersionOrTag arg1,
                                                              java.lang.String arg2)
                                                       throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return the Association Entity Code given an Association Name.

Specified by:
getAssociationCodeFromAssociationName in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - The local name or URN of the coding scheme.
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - The Association Name.
Returns:
The Association Entity Code.
Throws:
LBException

getAssociationNameFromAssociationCode

public java.lang.String getAssociationNameFromAssociationCode(java.lang.String arg0,
                                                              CodingSchemeVersionOrTag arg1,
                                                              java.lang.String arg2)
                                                       throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Return the Association Name given an Association Entity Code.

Specified by:
getAssociationNameFromAssociationCode in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - The local name or URN of the coding scheme.
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - The Association Entity Code.
Returns:
The Association Name.
Throws:
LBException

getHierarchyOrphanedConcepts

public ResolvedConceptReferenceList getHierarchyOrphanedConcepts(java.lang.String arg0,
                                                                 CodingSchemeVersionOrTag arg1,
                                                                 java.lang.String arg2)
                                                          throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns all concepts that can not be reached by traversing the hierarchy specified by the hierarchyId from the root.

Specified by:
getHierarchyOrphanedConcepts in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - The local name or URN of the coding scheme.
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, roots for all registered hierarchies are returned.
Returns:
The collection orphaned concepts; empty if the given hierarchy is not recognized or is unfulfilled by the given coding scheme and version.
Throws:
LBException

getHierarchyRoots

public ResolvedConceptReferenceList getHierarchyRoots(java.lang.String arg0,
                                                      CodingSchemeVersionOrTag arg1,
                                                      java.lang.String arg2,
                                                      boolean arg3)
                                               throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns all root nodes for the given hierarchy and coding scheme. Each root concept represents the conceptual start or narrowest point of a tree when visualizing the hierarchy.

Specified by:
getHierarchyRoots in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - The local name or URN of the coding scheme.
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - Identifies the type of hierarchy being traversed. Supported values for the coding scheme are retrievable through the getHierarchyIDs() method. If null, roots for all registered hierarchies are returned.
arg3 - True to fill in all information for concepts identified as part of the returned association; false to return only basic references (e.g. code, coding scheme, and description). If false, additional properties for referenced concepts can be resolved on an item-by-item basis as controlled by the application.
Returns:
The collection of references to root nodes; empty if the given hierarchy is not recognized or is unfulfilled by the given coding scheme and version.
Throws:
LBException

getAssociationNameForDirectionalName

public java.lang.String[] getAssociationNameForDirectionalName(java.lang.String arg0,
                                                               CodingSchemeVersionOrTag arg1,
                                                               java.lang.String arg2)
                                                        throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Gets the association names that contain a directional name.

Specified by:
getAssociationNameForDirectionalName in interface LexBIGServiceConvenienceMethods
Parameters:
arg0 - The local name or URN of the coding scheme.
arg1 - The assigned tag/label or absolute version identifier of the coding scheme.
arg2 - The directionalName string
Throws:
LBException

getSupportedPropertiesOfTypeComment

public java.util.List<SupportedProperty> getSupportedPropertiesOfTypeComment(java.lang.String arg0,
                                                                             CodingSchemeVersionOrTag arg1)
                                                                      throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns an list of properties supported with propertyType of 'comment'.

Specified by:
getSupportedPropertiesOfTypeComment in interface LexBIGServiceConvenienceMethods
Returns:
SupportedProperty
Throws:
LBException

getSupportedPropertiesOfTypeDefinition

public java.util.List<SupportedProperty> getSupportedPropertiesOfTypeDefinition(java.lang.String arg0,
                                                                                CodingSchemeVersionOrTag arg1)
                                                                         throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns an list of properties supported with propertyType of 'definition'.

Specified by:
getSupportedPropertiesOfTypeDefinition in interface LexBIGServiceConvenienceMethods
Returns:
SupportedProperty
Throws:
LBException

getSupportedPropertiesOfTypePresentation

public java.util.List<SupportedProperty> getSupportedPropertiesOfTypePresentation(java.lang.String arg0,
                                                                                  CodingSchemeVersionOrTag arg1)
                                                                           throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns an list of properties supported with propertyType of 'presentation'.

Specified by:
getSupportedPropertiesOfTypePresentation in interface LexBIGServiceConvenienceMethods
Returns:
SupportedProperty
Throws:
LBException

getSupportedPropertiesOfTypeProperty

public java.util.List<SupportedProperty> getSupportedPropertiesOfTypeProperty(java.lang.String arg0,
                                                                              CodingSchemeVersionOrTag arg1)
                                                                       throws LBException
Description copied from interface: LexBIGServiceConvenienceMethods
Returns an list of properties supported with propertyType of 'property'.

Specified by:
getSupportedPropertiesOfTypeProperty in interface LexBIGServiceConvenienceMethods
Returns:
SupportedProperty
Throws:
LBException

getNodesPath

public ResolvedConceptReference getNodesPath(java.lang.String arg0,
                                             CodingSchemeVersionOrTag arg1,
                                             java.lang.String arg2,
                                             java.lang.String arg3,
                                             java.lang.String arg4,
                                             java.lang.String arg5,
                                             java.lang.String arg6,
                                             java.lang.String arg7)
                                      throws LBParameterException
Description copied from interface: LexBIGServiceConvenienceMethods
Return the path/transitive closure path between two nodes.

Specified by:
getNodesPath in interface LexBIGServiceConvenienceMethods
Returns:
ResolvedConceptReference, which contains the path
Throws:
LBParameterException

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.