|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LexBIGServiceConvenienceMethods
Convenience methods to be implemented as a generic extension of the LexBIG API.
Nested Class Summary | |
---|---|
static class |
LexBIGServiceConvenienceMethods.HierarchyPathResolveOption
|
Method Summary | |
---|---|
void |
addEntityLuceneIndexes(java.lang.String codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.util.List<java.lang.String> entityCodes)
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 codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String associationName)
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 conceptCode,
java.lang.String relationContainerName,
java.lang.String association,
java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
boolean buildReferencedEntries,
NameAndValueList associationQualifiers)
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 codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String directionalName)
Gets the association names that contain a directional name. |
java.lang.String |
getAssociationNameFromAssociationCode(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String entityCode)
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 conceptCode,
java.lang.String relationContainerName,
java.lang.String association,
java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
boolean buildReferencedEntries,
NameAndValueList associationQualifiers)
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 |
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 versionOrTag)
Returns the identifiers for hierarchical relationships available for navigation within a coding scheme. |
AssociationList |
getHierarchyLevelNext(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
java.lang.String conceptCode,
boolean resolveConcepts,
boolean checkForHasHierarchyPathToRoot,
NameAndValueList associationQualifiers)
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 codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
ConceptReference conceptRef)
Return a count of the number of concepts at the next level in the hierarchy. |
ConceptReferenceList |
getHierarchyLevelNextCount(java.lang.String codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
ConceptReferenceList conceptCodes)
Returns a ConceptReferenceList of CountConceptReference that holds the count of concepts at the next level in the hierarchy. |
AssociationList |
getHierarchyLevelPrev(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
java.lang.String conceptCode,
boolean resolveConcepts,
boolean checkForHasHierarchyPathToRoot,
NameAndValueList associationQualifiers)
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 codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
ConceptReference conceptRef)
Return a count of the number of concepts at the previous level in the hierarchy. |
ConceptReferenceList |
getHierarchyLevelPrevCount(java.lang.String codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
ConceptReferenceList conceptCodes)
Returns a ConceptReferenceList of CountConceptReference that holds the count of concepts at the previous level in the hierarchy. |
ResolvedConceptReferenceList |
getHierarchyOrphanedConcepts(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID)
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 codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
boolean resolveConcepts)
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()
|
ResolvedConceptReference |
getNodesPath(java.lang.String codingSchemeUri,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String containerName,
java.lang.String associationName,
java.lang.String sourceCode,
java.lang.String sourceNS,
java.lang.String targetCode,
java.lang.String targetNS)
Return the path/transitive closure path between two nodes. |
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 codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyId)
Returns an array of hierarchies supported by the given coding scheme and matching the specified ID. |
java.util.List<SupportedProperty> |
getSupportedPropertiesOfTypeComment(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns an list of properties supported with propertyType of 'comment'. |
java.util.List<SupportedProperty> |
getSupportedPropertiesOfTypeDefinition(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns an list of properties supported with propertyType of 'definition'. |
java.util.List<SupportedProperty> |
getSupportedPropertiesOfTypePresentation(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns an list of properties supported with propertyType of 'presentation'. |
java.util.List<SupportedProperty> |
getSupportedPropertiesOfTypeProperty(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns an list of properties supported with propertyType of 'property'. |
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 codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.util.List<java.lang.String> entityCodes)
Modify LuceneIndexes for the given list of concept. |
void |
removeEntityLuceneIndexes(java.lang.String codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.util.List<java.lang.String> entityCodes)
Remove LuceneIndexes for the given list of concept. |
void |
setLexBIGService(LexBIGService lbs)
Assign the associated LexBIGService instance. |
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable |
---|
getDescription, getName, getProvider, getVersion |
Method Detail |
---|
LexBIGService getLexBIGService()
void setLexBIGService(LexBIGService lbs)
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.
CodedNodeSet createCodeNodeSet(java.lang.String[] conceptCodes, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
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.
LBException
java.lang.String getEntityDescription(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String code) throws LBException
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.
LBException
java.lang.String[] getHierarchyIDs(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
Possible return values are defined by the LexBIG model (see http://informatics.mayo.edu/LexGrid/downloads/LexGrid%20Model/ schemas/2008/01/EAwebpublish/index.htm).
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException
ResolvedConceptReferenceList getHierarchyRoots(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID) throws LBException
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.
LBException
ResolvedConceptReferenceList getHierarchyRoots(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, boolean resolveConcepts) throws LBException
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.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.
LBException
ResolvedConceptReferenceList getHierarchyOrphanedConcepts(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID) throws LBException
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.
LBException
CodedNodeSet getHierarchyRootSet(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID) throws LBException
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.
LBException
AssociationList getHierarchyLevelNext(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, NameAndValueList associationQualifiers) throws LBException
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.
LBException
AssociationList getHierarchyLevelNext(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, boolean checkForHasHierarchyPathToRoot, NameAndValueList associationQualifiers) throws LBException
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.checkForHasHierarchyPathToRoot
- 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 AssociationListassociationQualifiers
- Restrict to associations with specific qualifiers (e.g.
associations might be tagged with source-specific
information); null or empty to ignore qualifications.
LBException
AssociationList getHierarchyLevelPrev(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, NameAndValueList associationQualifiers) throws LBException
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.
LBException
AssociationList getHierarchyLevelPrev(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, boolean checkForHasHierarchyPathToRoot, NameAndValueList associationQualifiers) throws LBException
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.checkForHasHierarchyPathToRoot
- 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.associationQualifiers
- Restrict to associations with specific qualifiers (e.g.
associations might be tagged with source-specific
information); null or empty to ignore qualifications.
LBException
int getHierarchyLevelNextCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReference conceptRef) throws LBException
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).conceptRef
- The starting point for resolution; not null.
LBException
int getHierarchyLevelPrevCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReference conceptRef) throws LBException
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).conceptRef
- The starting point for resolution; not null.
LBException
ConceptReferenceList getHierarchyLevelNextCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReferenceList conceptCodes) throws LBException
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).ConceptReferenceList
- The list of concepts for which we want to find counts
LBException
ConceptReferenceList getHierarchyLevelPrevCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReferenceList conceptCodes) throws LBException
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).ConceptReferenceList
- The list of concepts for which we want to find counts
LBException
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
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.
LBException
ResolvedConceptReference getNodesPath(java.lang.String codingSchemeUri, CodingSchemeVersionOrTag versionOrTag, java.lang.String containerName, java.lang.String associationName, java.lang.String sourceCode, java.lang.String sourceNS, java.lang.String targetCode, java.lang.String targetNS) throws LBParameterException
codingSchemeUri
- versionOrTag
- containerName
- associationName
- sourceCode
- sourceNS
- targetCode
- targetNS
-
LBParameterException
CodingSchemeRendering getRenderingDetail(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException
boolean isCodeRetired(java.lang.String conceptCode, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
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.
LBException
CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(java.lang.String associationName) throws LBException
associationName
- Association name to search for. It is case sensitive.
LBException
java.lang.String getCodingSchemeCopyright(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException
java.lang.String getAssociationNameFromAssociationCode(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String entityCode) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.entityCode
- The Association Entity Code.
LBException
java.lang.String getAssociationCodeFromAssociationName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String associationName) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.associationName
- The Association Name.
LBException
java.lang.String[] getAssociationForwardAndReverseNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException
java.lang.String getAssociationForwardName(java.lang.String association, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
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.
LBException
java.lang.String[] getAssociationForwardNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException
java.lang.String getAssociationReverseName(java.lang.String association, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
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.
LBException
java.lang.String[] getAssociationReverseNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException
boolean isForwardName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String directionalName) throws LBException
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
LBException
boolean isReverseName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String directionalName) throws LBException
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
LBException
java.lang.String[] getAssociationNameForDirectionalName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String directionalName) throws LBException
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
LBException
Association getAssociationReverseOneLevel(java.lang.String conceptCode, java.lang.String relationContainerName, java.lang.String association, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, boolean buildReferencedEntries, NameAndValueList associationQualifiers) throws LBException
conceptCode
- ConceptCode to lookup.relationContainerName
- The relations container to query. If null, the native
relations container for the code system will be assumed.association
- Local name of the specific relation/association to evaluate
("hasSubtype", etc).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.buildReferencedEntries
- true to resolve the full concept codes, false for skeletonsassociationQualifiers
- Restrict to associations with specific qualifiers, for example
from a specific source
LBException
Association getAssociationForwardOneLevel(java.lang.String conceptCode, java.lang.String relationContainerName, java.lang.String association, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, boolean buildReferencedEntries, NameAndValueList associationQualifiers) throws LBException
conceptCode
- The conceptCode to lookup.relationContainerName
- The relations container to query. If null, the native
relations container for the code system will be assumed.association
- Local name of the specific relation/association to evaluate
("hasSubtype", etc).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.buildReferencedEntries
- true to resolve the full concept codes, false for skeletonsassociationQualifiers
- Restrict to associations with specific qualifiers, for example
from a specific source
LBException
SupportedHierarchy[] getSupportedHierarchies(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyId) throws LBException
codingScheme
- versionOrTag
- hierarchyId
-
LBException
java.util.List<SupportedProperty> getSupportedPropertiesOfTypePresentation(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- versionOrTag
-
LBException
java.util.List<SupportedProperty> getSupportedPropertiesOfTypeComment(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- versionOrTag
-
LBException
java.util.List<SupportedProperty> getSupportedPropertiesOfTypeDefinition(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- versionOrTag
-
LBException
java.util.List<SupportedProperty> getSupportedPropertiesOfTypeProperty(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- versionOrTag
-
LBException
void addEntityLuceneIndexes(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.util.List<java.lang.String> entityCodes) throws LBException
codingSchemeName
- versionOrTag
- entityCodes
-
LBException
void removeEntityLuceneIndexes(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.util.List<java.lang.String> entityCodes) throws LBException
codingSchemeName
- versionOrTag
- entityCodes
-
LBException
void modifyEntityLuceneIndexes(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.util.List<java.lang.String> entityCodes) throws LBException
codingSchemeName
- versionOrTag
- entityCodes
-
LBException
|
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |