public class LexBIGServiceConvenienceMethodsImpl extends java.lang.Object implements LexBIGServiceConvenienceMethods
LexBIGServiceConvenienceMethods.HierarchyPathResolveOption
Constructor and Description |
---|
LexBIGServiceConvenienceMethodsImpl() |
Modifier and Type | Method and Description |
---|---|
void |
addEntityLuceneIndexes(java.lang.String codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.util.List<java.lang.String> entityCodes)
Add LuceneIndexes for the given list of concepts.
|
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.
|
protected java.lang.String |
doGetAssociationDirectionalName(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String associationName,
org.LexGrid.LexBIG.Impl.Extensions.GenericExtensions.LexBIGServiceConvenienceMethodsImpl.DirectionalName direction) |
protected java.lang.String[] |
doGetAssociationNames(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
org.LexGrid.LexBIG.Impl.Extensions.GenericExtensions.LexBIGServiceConvenienceMethodsImpl.DirectionalName direction) |
AssociatedConceptList |
getallIncomingConceptsForAssociation(java.lang.String codingScheme,
CodingSchemeVersionOrTag csvt,
java.lang.String code,
java.lang.String associationName,
int maxToReturn) |
java.util.List<ResolvedConceptReference> |
getAncestorsInTransitiveClosure(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String code,
java.lang.String association) |
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 associationName,
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 associationName,
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.
|
protected java.util.Map |
getCache_CodingSchemes()
Return the map used to cache codingScheme copyRitght information, which
maps from key (derived from request parameters) to CopyRight String.
|
protected java.util.Map |
getCache_CopyRights()
Return the map used to cache codingScheme information, which maps from
key (derived from request parameters) to CodingScheme object.
|
protected java.util.Map |
getCache_HIDs()
Return the map used to cache hierarchy ID information, which maps from
key (derived from request parameters) to an array of hierarchy IDs
(String[]).
|
protected java.util.Map |
getCache_HPathToRootExists()
Return the map used to cache hierarchy root existence, which maps from
key (derived from request parameters) to a Boolean value.
|
protected java.util.Map |
getCache_HRootCodes()
Return the map used to cache hierarchy root code information, which maps
from key (derived from request parameters) to an array of root codes
(String[]).
|
protected java.util.Map |
getCache_HRoots()
Return the map used to cache hierarchy root information, which maps from
key (derived from request parameters) to a ResolvedConceptReferenceList.
|
protected java.lang.Object |
getCacheKey(java.lang.Object[] basis)
Return a cache key based on the given items.
|
protected CodingScheme |
getCodingScheme(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Primitive method to resolve and cache coding scheme representations.
|
java.lang.String |
getCodingSchemeCopyright(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Primitive method to resolve and cache coding scheme copyRight text.
|
CodingSchemeRenderingList |
getCodingSchemesWithSupportedAssociation(java.lang.String associationName)
Return the coding schemes who supported association matching with
associationName.
|
java.util.List<ResolvedConceptReference> |
getDescendentsInTransitiveClosure(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String code,
java.lang.String association) |
java.lang.String |
getDescription()
Return a description of the extension.
|
java.util.List<java.lang.String> |
getDistinctNamespacesOfCode(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String code)
Gets the distinct namespaces of a code.
|
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.
|
protected AssociationList |
getHierarchyLevelNext(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String[] assocNames,
boolean fwd,
java.lang.String conceptCode,
boolean resolveConcepts,
NameAndValueList assocQuals)
Primitive method to retrieve next level of hierarchy based on association
names and directionality, but could ultimately be linked to several root
nodes based on supported hierarchy definitions.
|
AssociationList |
getHierarchyLevelNext(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
java.lang.String conceptCode,
boolean resolveConcepts,
boolean checkForHasHierarchyPathToRoot,
NameAndValueList assocQuals)
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 assocQuals)
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.
|
protected ConceptReferenceList |
getHierarchyLevelNextCount(java.lang.String codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
ConceptReferenceList conceptCodes,
boolean forward) |
protected ConceptReferenceList |
getHierarchyLevelNextCountBackwardCompatible(java.lang.String codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
ConceptReferenceList conceptCodes,
boolean forward) |
AssociationList |
getHierarchyLevelPrev(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
java.lang.String conceptCode,
boolean resolveConcepts,
boolean checkForHasHierarchyPathToRoot,
NameAndValueList assocQuals)
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 assocQuals)
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.
|
protected ResolvedConceptReferenceList |
getHierarchyNodesNext(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String[] assocNames,
boolean fwd,
java.lang.String conceptCode,
boolean resolveConcepts,
NameAndValueList assocQuals)
Primitive method to retrieve next level of hierarchy based on association
names and directionality, but could ultimately be linked to several root
nodes based on supported hierarchy definitions.
|
ResolvedConceptReferenceList |
getHierarchyOrphanedConcepts(java.lang.String codingSchemeName,
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.
|
protected AssociationList |
getHierarchyPathToRoot(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String[] assocNames,
boolean fwd,
java.lang.String conceptCode,
java.lang.String rootCode,
java.lang.String namespace,
boolean resolveConcepts,
NameAndValueList assocQuals,
int maxToReturn)
Returns a list of associations representing navigable paths between the
given concept and root node combination.
|
AssociationList |
getHierarchyPathToRoot(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
java.lang.String conceptCode,
boolean resolveConcepts,
LexBIGServiceConvenienceMethods.HierarchyPathResolveOption pathResolveOption,
NameAndValueList assocQuals)
Return a representation of associations between a concept and
hierarchical root node(s).
|
AssociationList |
getHierarchyPathToRoot(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID,
java.lang.String conceptCode,
java.lang.String namespace,
boolean resolveConcepts,
LexBIGServiceConvenienceMethods.HierarchyPathResolveOption pathResolveOption,
NameAndValueList assocQuals)
Return a representation of associations between a concept and
hierarchical root node(s).
|
protected AssociationList |
getHierarchyPathToRootPrim(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String[] assocNames,
boolean fwd,
java.lang.String conceptCode,
java.lang.String namespace,
java.lang.String rootCode,
boolean resolveConcepts,
NameAndValueList assocQuals,
int maxToReturn)
Resolves all links representing navigable paths between the start and
stop codes for the given association, adding them to the returned
association list.
|
protected AssociationList |
getHierarchyPathToRootPrim(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String[] assocNames,
boolean fwd,
java.lang.String conceptCode,
java.lang.String namespace,
java.lang.String rootCode,
boolean resolveConcepts,
NameAndValueList assocQuals,
int maxToReturn,
java.util.List<java.lang.String> codeChain) |
protected java.lang.String[] |
getHierarchyRootCodes(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String hierarchyID)
Return a basic array of strings containing root codes for the given
hierarchy ID.
|
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()
Return the associated LexBIGService instance; lazy initialized as
required.
|
LgLoggerIF |
getLogger() |
java.lang.String |
getName()
Return the name assigned to this service extension.
|
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.
|
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.
|
protected SupportedHierarchy[] |
getSupportedHierarchies(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns an array of hierarchies supported by the given coding scheme.
|
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'.
|
TerminologyServiceDesignation |
getTerminologyServiceObjectType(java.lang.String uri) |
java.lang.String |
getVersion()
Return version information about the extension.
|
protected boolean |
hasHierarchyPathToRoot(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String[] assocNames,
boolean fwd,
java.lang.String conceptCode,
java.lang.String[] rootCodes,
NameAndValueList assocQuals)
Returns an indication of whether a path exists between the given concept
and the set of root concepts for the given associations in the given
direction.
|
protected boolean |
hasHierarchyPathToRoot(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String[] assocNames,
boolean fwd,
java.lang.String conceptCode,
java.lang.String rootCode,
NameAndValueList assocQuals)
Returns an indication of whether a path exists between the given concept
and root for the given associations in the given direction.
|
protected boolean |
hasHierarchyPathToRootMultiAxis(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String[] assocNames,
boolean fwd,
java.lang.String conceptCode,
java.lang.String rootCode,
NameAndValueList assocQuals)
Returns an indication of whether a path exists between the given concept
and root for the given associations in the given direction.
|
protected boolean |
hasHierarchyPathToRootSingleAxis(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String assocName,
boolean fwd,
java.lang.String conceptCode,
java.lang.String rootCode,
NameAndValueList assocQuals)
Returns an indication of whether a path exists between the given concept
and root for the given associations in the given direction.
|
boolean |
isCodeRetired(java.lang.String code,
java.lang.String codingSchemeName,
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 forwardName 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 reverseName 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 concepts.
|
static void |
register() |
void |
removeEntityLuceneIndexes(java.lang.String codingSchemeName,
CodingSchemeVersionOrTag versionOrTag,
java.util.List<java.lang.String> entityCodes)
Remove LuceneIndexes for the given list of concepts.
|
ResolvedConceptReferenceList |
searchAscendentsInTransitiveClosure(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.util.List<java.lang.String> codes,
java.lang.String association,
java.lang.String matchText,
java.lang.String alg,
CodedNodeSet.SearchDesignationOption searchOption,
LocalNameList sources) |
ResolvedConceptReferenceList |
searchDescendentsInTransitiveClosure(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.util.List<java.lang.String> codes,
java.lang.String association,
java.lang.String matchText,
java.lang.String alg,
CodedNodeSet.SearchDesignationOption searchOption,
LocalNameList sources) |
void |
setLexBIGService(LexBIGService lbs)
Assign the associated LexBIGService instance.
|
public LgLoggerIF getLogger()
public static void register() throws LBParameterException, LBException
LBParameterException
LBException
public CodedNodeSet createCodeNodeSet(java.lang.String[] conceptCodes, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
createCodeNodeSet
in interface LexBIGServiceConvenienceMethods
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
public 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
LexBIGServiceConvenienceMethods
getAssociationForwardOneLevel
in interface LexBIGServiceConvenienceMethods
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 sourceLBException
public 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
LexBIGServiceConvenienceMethods
getAssociationReverseOneLevel
in interface LexBIGServiceConvenienceMethods
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 sourceLBException
public boolean isCodeRetired(java.lang.String code, java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
isCodeRetired
in interface LexBIGServiceConvenienceMethods
code
- The concept code to evaluate.codingSchemeName
- 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
public java.lang.String getName()
Extendable
getName
in interface Extendable
public java.lang.String getDescription()
Extendable
getDescription
in interface Extendable
public java.lang.String getVersion()
Extendable
getVersion
in interface Extendable
public java.lang.String getProvider()
Extendable
getProvider
in interface Extendable
public CodingSchemeRendering getRenderingDetail(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getRenderingDetail
in interface LexBIGServiceConvenienceMethods
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.LBException
public CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(java.lang.String associationName) throws LBException
LexBIGServiceConvenienceMethods
getCodingSchemesWithSupportedAssociation
in interface LexBIGServiceConvenienceMethods
associationName
- Association name to search for. It is case sensitive.LBException
public java.lang.String getAssociationCodeFromAssociationName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String associationName) throws LBException
LexBIGServiceConvenienceMethods
getAssociationCodeFromAssociationName
in interface LexBIGServiceConvenienceMethods
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
public java.lang.String getAssociationNameFromAssociationCode(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String entityCode) throws LBException
LexBIGServiceConvenienceMethods
getAssociationNameFromAssociationCode
in interface LexBIGServiceConvenienceMethods
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
public java.lang.String[] getAssociationNameForDirectionalName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String directionalName) throws LBException
LexBIGServiceConvenienceMethods
getAssociationNameForDirectionalName
in interface LexBIGServiceConvenienceMethods
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 stringLBException
public java.lang.String getAssociationForwardName(java.lang.String associationName, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getAssociationForwardName
in interface LexBIGServiceConvenienceMethods
associationName
- 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
protected java.lang.String doGetAssociationDirectionalName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String associationName, org.LexGrid.LexBIG.Impl.Extensions.GenericExtensions.LexBIGServiceConvenienceMethodsImpl.DirectionalName direction) throws LBException
LBException
protected java.lang.String[] doGetAssociationNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.Impl.Extensions.GenericExtensions.LexBIGServiceConvenienceMethodsImpl.DirectionalName direction) throws LBException
LBException
public java.lang.String[] getAssociationForwardNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getAssociationForwardNames
in interface LexBIGServiceConvenienceMethods
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.LBException
public java.lang.String getAssociationReverseName(java.lang.String associationName, java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getAssociationReverseName
in interface LexBIGServiceConvenienceMethods
associationName
- 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
public java.lang.String[] getAssociationReverseNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getAssociationReverseNames
in interface LexBIGServiceConvenienceMethods
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.LBException
public java.lang.String[] getAssociationForwardAndReverseNames(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getAssociationForwardAndReverseNames
in interface LexBIGServiceConvenienceMethods
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.LBException
public boolean isForwardName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String directionalName) throws LBException
isForwardName
in interface LexBIGServiceConvenienceMethods
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 stringLBException
public boolean isReverseName(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String directionalName) throws LBException
isReverseName
in interface LexBIGServiceConvenienceMethods
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 stringLBException
public java.lang.String[] getHierarchyIDs(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
Possible return values are defined by the LexBIG model (see http://informatics.mayo.edu/LexGrid/downloads/LexGrid%20Model/ schemas/2008/01/EAwebpublish/index.htm).
getHierarchyIDs
in interface LexBIGServiceConvenienceMethods
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.LBException
public ConceptReferenceList getHierarchyLevelNextCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReferenceList conceptCodes) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyLevelNextCount
in interface LexBIGServiceConvenienceMethods
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).LBException
public ConceptReferenceList getHierarchyLevelPrevCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReferenceList conceptCodes) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyLevelPrevCount
in interface LexBIGServiceConvenienceMethods
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).LBException
public int getHierarchyLevelNextCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReference conceptRef) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyLevelNextCount
in interface LexBIGServiceConvenienceMethods
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
public int getHierarchyLevelPrevCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReference conceptRef) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyLevelPrevCount
in interface LexBIGServiceConvenienceMethods
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
protected ConceptReferenceList getHierarchyLevelNextCountBackwardCompatible(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReferenceList conceptCodes, boolean forward) throws LBException
LBException
protected ConceptReferenceList getHierarchyLevelNextCount(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, ConceptReferenceList conceptCodes, boolean forward) throws LBException
LBException
public AssociationList getHierarchyLevelNext(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, boolean checkForHasHierarchyPathToRoot, NameAndValueList assocQuals) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyLevelNext
in interface LexBIGServiceConvenienceMethods
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 AssociationListassocQuals
- Restrict to associations with specific qualifiers (e.g.
associations might be tagged with source-specific
information); null or empty to ignore qualifications.LBException
public AssociationList getHierarchyLevelNext(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, NameAndValueList assocQuals) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyLevelNext
in interface LexBIGServiceConvenienceMethods
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.assocQuals
- Restrict to associations with specific qualifiers (e.g.
associations might be tagged with source-specific
information); null or empty to ignore qualifications.LBException
public AssociationList getHierarchyLevelPrev(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, boolean checkForHasHierarchyPathToRoot, NameAndValueList assocQuals) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyLevelPrev
in interface LexBIGServiceConvenienceMethods
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.assocQuals
- Restrict to associations with specific qualifiers (e.g.
associations might be tagged with source-specific
information); null or empty to ignore qualifications.LBException
public AssociationList getHierarchyLevelPrev(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, NameAndValueList assocQuals) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyLevelPrev
in interface LexBIGServiceConvenienceMethods
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.assocQuals
- Restrict to associations with specific qualifiers (e.g.
associations might be tagged with source-specific
information); null or empty to ignore qualifications.LBException
public AssociationList getHierarchyPathToRoot(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, boolean resolveConcepts, LexBIGServiceConvenienceMethods.HierarchyPathResolveOption pathResolveOption, NameAndValueList assocQuals) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyPathToRoot
in interface LexBIGServiceConvenienceMethods
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.assocQuals
- Restrict to associations with specific qualifiers (e.g.
associations might be tagged with source-specific
information); null or empty to ignore qualifications.LBException
public AssociationList getHierarchyPathToRoot(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, java.lang.String conceptCode, java.lang.String namespace, boolean resolveConcepts, LexBIGServiceConvenienceMethods.HierarchyPathResolveOption pathResolveOption, NameAndValueList assocQuals) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyPathToRoot
in interface LexBIGServiceConvenienceMethods
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.assocQuals
- Restrict to associations with specific qualifiers (e.g.
associations might be tagged with source-specific
information); null or empty to ignore qualifications.LBException
public ResolvedConceptReferenceList getHierarchyRoots(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyRoots
in interface LexBIGServiceConvenienceMethods
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
public ResolvedConceptReferenceList getHierarchyRoots(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID, boolean resolveConcepts) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyRoots
in interface LexBIGServiceConvenienceMethods
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
public CodedNodeSet getHierarchyRootSet(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyRootSet
in interface LexBIGServiceConvenienceMethods
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
protected CodingScheme getCodingScheme(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- versionOrTag
- LBException
public java.lang.String getCodingSchemeCopyright(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
getCodingSchemeCopyright
in interface LexBIGServiceConvenienceMethods
codingScheme
- versionOrTag
- LBException
protected AssociationList getHierarchyLevelNext(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String[] assocNames, boolean fwd, java.lang.String conceptCode, boolean resolveConcepts, NameAndValueList assocQuals) throws LBException
Returns the list of concepts that match the given concept and association names, empty if none are available.
codingScheme
- versionOrTag
- assocNames
- fwd
- conceptCode
- resolveConcepts
- assocQuals
- LBException
protected ResolvedConceptReferenceList getHierarchyNodesNext(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String[] assocNames, boolean fwd, java.lang.String conceptCode, boolean resolveConcepts, NameAndValueList assocQuals) throws LBException
Returns the list of concepts that match the given concept and association names, empty if none are available.
codingScheme
- versionOrTag
- assocNames
- fwd
- conceptCode
- assocQuals
- resolveConcepts
- LBException
protected AssociationList getHierarchyPathToRoot(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String[] assocNames, boolean fwd, java.lang.String conceptCode, java.lang.String rootCode, java.lang.String namespace, boolean resolveConcepts, NameAndValueList assocQuals, int maxToReturn) throws LBException
This method handles caching. The primitive methods performing the actual resolve are the single and multi-root getters.
Returns the resolved chain; empty if the association cannot be followed from the concept to root code.
Note: For purposes of this method, hierarchical associations are assumed to be transitive.
codingScheme
- versionOrTag
- assocNames
- fwd
- conceptCode
- rootCode
- namespace
- resolveConcepts
- assocQuals
- maxToReturn
- LBException
protected AssociationList getHierarchyPathToRootPrim(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String[] assocNames, boolean fwd, java.lang.String conceptCode, java.lang.String namespace, java.lang.String rootCode, boolean resolveConcepts, NameAndValueList assocQuals, int maxToReturn) throws LBException
Returns the resolved chain; empty if the association cannot be followed from the concept to root code.
Note: For purposes of this method, hierarchical associations are assumed to be transitive.
codingScheme
- versionOrTag
- assocName
- fwd
- conceptCode
- rootCode
- resolveConcepts
- pathResolveOption
- assocQuals
- maxToReturn
- LBException
protected AssociationList getHierarchyPathToRootPrim(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String[] assocNames, boolean fwd, java.lang.String conceptCode, java.lang.String namespace, java.lang.String rootCode, boolean resolveConcepts, NameAndValueList assocQuals, int maxToReturn, java.util.List<java.lang.String> codeChain) throws LBException
LBException
protected java.lang.String[] getHierarchyRootCodes(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID) throws LBException
codingScheme
- versionOrTag
- hierarchyID
- LBException
protected SupportedHierarchy[] getSupportedHierarchies(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
codingScheme
- versionOrTag
- LBException
public SupportedHierarchy[] getSupportedHierarchies(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyId) throws LBException
getSupportedHierarchies
in interface LexBIGServiceConvenienceMethods
codingScheme
- versionOrTag
- hierarchyId
- LBException
protected boolean hasHierarchyPathToRoot(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String[] assocNames, boolean fwd, java.lang.String conceptCode, java.lang.String[] rootCodes, NameAndValueList assocQuals) throws LBException
Note: For purposes of this method, hierarchical associations are assumed to be transitive. When possible, transitive closure is used as a shortcut to determine the answer.
codingScheme
- versionOrTag
- assocNames
- fwd
- conceptCode
- rootCodes
- assocQuals
- LBException
protected boolean hasHierarchyPathToRoot(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String[] assocNames, boolean fwd, java.lang.String conceptCode, java.lang.String rootCode, NameAndValueList assocQuals) throws LBException
Note: For purposes of this method, hierarchical associations are assumed to be transitive. When possible, transitive closure is used as a shortcut to determine the answer.
codingScheme
- versionOrTag
- assocNames
- fwd
- conceptCode
- rootCode
- assocQuals
- LBException
protected boolean hasHierarchyPathToRootSingleAxis(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String assocName, boolean fwd, java.lang.String conceptCode, java.lang.String rootCode, NameAndValueList assocQuals) throws LBException
Note: For purposes of this method, hierarchical associations are assumed to be transitive. When possible, transitive closure is used as a shortcut to determine the answer.
codingScheme
- versionOrTag
- assocName
- fwd
- conceptCode
- rootCode
- assocQuals
- LBException
protected boolean hasHierarchyPathToRootMultiAxis(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String[] assocNames, boolean fwd, java.lang.String conceptCode, java.lang.String rootCode, NameAndValueList assocQuals) throws LBException
Note: For purposes of this method, hierarchical associations are assumed to be transitive. When possible, transitive closure is used as a shortcut to determine the answer.
codingScheme
- versionOrTag
- assocNames
- fwd
- conceptCode
- rootCode
- assocQuals
- LBException
public 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.
setLexBIGService
in interface LexBIGServiceConvenienceMethods
public LexBIGService getLexBIGService()
getLexBIGService
in interface LexBIGServiceConvenienceMethods
protected java.lang.Object getCacheKey(java.lang.Object[] basis)
basis
- protected java.util.Map getCache_CopyRights()
Note: Methods requiring the cache should invoke this method rather than directly referencing the class variable in order to allow lazy initialization.
protected java.util.Map getCache_CodingSchemes()
Note: Methods requiring the cache should invoke this method rather than directly referencing the class variable in order to allow lazy initialization.
protected java.util.Map getCache_HIDs()
Note: Methods requiring the cache should invoke this method rather than directly referencing the class variable in order to allow lazy initialization.
protected java.util.Map getCache_HRoots()
Note: Methods requiring the cache should invoke this method rather than directly referencing the class variable in order to allow lazy initialization.
protected java.util.Map getCache_HRootCodes()
Note: Methods requiring the cache should invoke this method rather than directly referencing the class variable in order to allow lazy initialization.
protected java.util.Map getCache_HPathToRootExists()
Note: Methods requiring the cache should invoke this method rather than directly referencing the class variable in order to allow lazy initialization.
public java.lang.String getEntityDescription(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String code) throws LBException
getEntityDescription
in interface LexBIGServiceConvenienceMethods
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
public void addEntityLuceneIndexes(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.util.List<java.lang.String> entityCodes) throws LBException
addEntityLuceneIndexes
in interface LexBIGServiceConvenienceMethods
codingSchemeName
- versionOrTag
- entityCode
- LBException
public void removeEntityLuceneIndexes(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.util.List<java.lang.String> entityCodes) throws LBException
removeEntityLuceneIndexes
in interface LexBIGServiceConvenienceMethods
codingSchemeName
- versionOrTag
- entityCode
- LBException
public void modifyEntityLuceneIndexes(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.util.List<java.lang.String> entityCodes) throws LBException
modifyEntityLuceneIndexes
in interface LexBIGServiceConvenienceMethods
codingSchemeName
- versionOrTag
- entityCode
- LBException
public ResolvedConceptReferenceList getHierarchyOrphanedConcepts(java.lang.String codingSchemeName, CodingSchemeVersionOrTag versionOrTag, java.lang.String hierarchyID) throws LBException
LexBIGServiceConvenienceMethods
getHierarchyOrphanedConcepts
in interface LexBIGServiceConvenienceMethods
codingSchemeName
- 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
public java.util.List<SupportedProperty> getSupportedPropertiesOfTypeComment(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getSupportedPropertiesOfTypeComment
in interface LexBIGServiceConvenienceMethods
LBException
public java.util.List<SupportedProperty> getSupportedPropertiesOfTypeDefinition(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getSupportedPropertiesOfTypeDefinition
in interface LexBIGServiceConvenienceMethods
LBException
public java.util.List<SupportedProperty> getSupportedPropertiesOfTypePresentation(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getSupportedPropertiesOfTypePresentation
in interface LexBIGServiceConvenienceMethods
LBException
public java.util.List<SupportedProperty> getSupportedPropertiesOfTypeProperty(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGServiceConvenienceMethods
getSupportedPropertiesOfTypeProperty
in interface LexBIGServiceConvenienceMethods
LBException
public 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
LexBIGServiceConvenienceMethods
getNodesPath
in interface LexBIGServiceConvenienceMethods
LBParameterException
public java.util.List<java.lang.String> getDistinctNamespacesOfCode(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String code) throws LBException
LexBIGServiceConvenienceMethods
getDistinctNamespacesOfCode
in interface LexBIGServiceConvenienceMethods
codingScheme
- the coding schemeversionOrTag
- the version or tagcode
- the codeLBException
- the LB exceptionpublic java.util.List<ResolvedConceptReference> getAncestorsInTransitiveClosure(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String code, java.lang.String association) throws LBParameterException
getAncestorsInTransitiveClosure
in interface LexBIGServiceConvenienceMethods
codingScheme
- the coding schemeversionOrTag
- the version or tagcode
- the unique identifier in the code systemassociation
- the relationship to restrict this toLBParameterException
- caused by an incorrect parameter for this methodpublic java.util.List<ResolvedConceptReference> getDescendentsInTransitiveClosure(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String code, java.lang.String association) throws LBParameterException
getDescendentsInTransitiveClosure
in interface LexBIGServiceConvenienceMethods
codingScheme
- the coding schemeversionOrTag
- the version or tagcode
- unique id in the code systemassociation
- relationship to restrict toLBParameterException
- incorrect parameter will cause thispublic AssociatedConceptList getallIncomingConceptsForAssociation(java.lang.String codingScheme, CodingSchemeVersionOrTag csvt, java.lang.String code, java.lang.String associationName, int maxToReturn) throws LBInvocationException, LBParameterException, LBException
getallIncomingConceptsForAssociation
in interface LexBIGServiceConvenienceMethods
codingScheme
- the code systemcsvt
- the version or tagcode
- the unique identifier in the code systemassociationName
- the relationship to restrict this tomaxToReturn
- the maximum number of values to returnLBInvocationException
LBParameterException
LBException
public ResolvedConceptReferenceList searchDescendentsInTransitiveClosure(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.util.List<java.lang.String> codes, java.lang.String association, java.lang.String matchText, java.lang.String alg, CodedNodeSet.SearchDesignationOption searchOption, LocalNameList sources) throws LBParameterException
searchDescendentsInTransitiveClosure
in interface LexBIGServiceConvenienceMethods
codingScheme
- the coding scheme focus of the searchversionOrTag
- coding scheme versioncodes
- that are top nodes of a domainassociation
- the relationship name that determines the domainmatchText
- text to match domain membersLBParameterException
public ResolvedConceptReferenceList searchAscendentsInTransitiveClosure(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.util.List<java.lang.String> codes, java.lang.String association, java.lang.String matchText, java.lang.String alg, CodedNodeSet.SearchDesignationOption searchOption, LocalNameList sources) throws LBParameterException
searchAscendentsInTransitiveClosure
in interface LexBIGServiceConvenienceMethods
codingScheme
- the coding scheme focus of the searchversionOrTag
- coding scheme versioncodes
- that are top nodes of a domainassociation
- the relationship name that determines the domainmatchText
- text to match domain membersLBParameterException
public TerminologyServiceDesignation getTerminologyServiceObjectType(java.lang.String uri)
getTerminologyServiceObjectType
in interface LexBIGServiceConvenienceMethods
uri
- of the Terminology Object