|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LexBIGServiceConvenienceMethodsGrid
Convenience methods to be implemented as a generic extension of the LexBIG API.
Method Summary | |
---|---|
CodedNodeSetGrid |
createCodeNodeSet(ConceptIdentification[] conceptCodes,
CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Create a CodedNodeSet from a set of concept codes in a coding scheme. |
AssociationIdentification[] |
getAssociationForwardAndReverseNames(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return all the association forward name and reverse name for the coding scheme. |
DirectionalAssociationIdentification |
getAssociationForwardName(AssociationIdentification association,
CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return the forward name for the identified association. |
DirectionalAssociationIdentification[] |
getAssociationForwardNames(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return all the association forward name for the coding scheme. |
DirectionalAssociationIdentification |
getAssociationReverseName(AssociationIdentification association,
CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return the reverse name for the identified association. |
DirectionalAssociationIdentification[] |
getAssociationReverseNames(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return all the association reverse name for the coding scheme. |
CodingSchemeCopyRight |
getCodingSchemeCopyright(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return the copyright text for the coding scheme. |
CodingSchemeRenderingList |
getCodingSchemesWithSupportedAssociation(AssociationIdentification AssociationIdentification)
Return the coding schemes who supported association matching with AssociationIdentification. |
HierarchyIdentification[] |
getHierarchyIDs(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns the identifiers for hierarchical relationships available for navigation within a coding scheme. |
AssociationList |
getHierarchyLevelNext(HierarchyResolutionPolicy policy,
CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return a representation of associations between a concept and its immediate decendents. |
AssociationList |
getHierarchyLevelPrev(HierarchyResolutionPolicy policy,
CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return a representation of associations between a concept and its immediate ancestor(s). |
AssociationList |
getHierarchyPathToRoot(HierarchyResolutionPolicy policy,
CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag,
HierarchyPathResolveOption pathResolveOption)
Return a representation of associations between a concept and hierarchical root node(s). |
ResolvedConceptReferenceList |
getHierarchyRoots(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag,
HierarchyIdentification hierarchyIdentification)
Returns all root nodes for the given hierarchy and coding scheme. |
CodedNodeSetGrid |
getHierarchyRootSet(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag,
HierarchyIdentification hierarchyIdentification)
Returns all root nodes for the given hierarchy as a CodeNodeSet, which can be further restricted. |
CodingSchemeRendering |
getRenderingDetail(CodingSchemeIdentification 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. |
CodeState |
isCodeRetired(ConceptIdentification conceptCode,
CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Indicates if the given code is considered retired or inactive within context of the provided scheme. |
Direction |
isForwardName(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag,
AssociationIdentification directionalName)
Return true if directionalName is the forward name of an association for the coding scheme. |
Direction |
isReverseName(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag,
AssociationIdentification directionalName)
Return true if directionalName is the reverse name of an association for the coding scheme. |
Method Detail |
---|
CodedNodeSetGrid createCodeNodeSet(ConceptIdentification[] conceptCodes, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
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,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
HierarchyIdentification[] getHierarchyIDs(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
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,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
ResolvedConceptReferenceList getHierarchyRoots(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, HierarchyIdentification hierarchyIdentification) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.hierarchyIdentification
- Identifies the type of hierarchy being traversed.
Supported values for the coding scheme are retrievable
through the getHierarchyIdentifications() method. If null, roots
for all registered hierarchies are returned.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
CodedNodeSetGrid getHierarchyRootSet(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, HierarchyIdentification hierarchyIdentification) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.hierarchyIdentification
- Identifies the type of hierarchy being traversed.
Supported values for the coding scheme are retrievable
through the getHierarchyIdentifications() method. If null, roots
for all registered hierarchies are returned.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
AssociationList getHierarchyLevelNext(HierarchyResolutionPolicy policy, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
policy
- Policy for resolving the hierarchycodingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
AssociationList getHierarchyLevelPrev(HierarchyResolutionPolicy policy, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
policy
- Policy for resolving the CodedNodeSetcodingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
AssociationList getHierarchyPathToRoot(HierarchyResolutionPolicy policy, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, HierarchyPathResolveOption pathResolveOption) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
policy
- Policy for resolving the CodedNodeSetcodingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
CodingSchemeRendering getRenderingDetail(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
CodeState isCodeRetired(ConceptIdentification conceptCode, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
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,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(AssociationIdentification AssociationIdentification) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
AssociationIdentification
- Association name to search for. It is case sensitive.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
AssociationIdentification[] getAssociationForwardAndReverseNames(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
DirectionalAssociationIdentification getAssociationForwardName(AssociationIdentification association, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
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,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
DirectionalAssociationIdentification[] getAssociationForwardNames(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
DirectionalAssociationIdentification getAssociationReverseName(AssociationIdentification association, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
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,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
DirectionalAssociationIdentification[] getAssociationReverseNames(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
Direction isForwardName(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, AssociationIdentification directionalName) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
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,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
Direction isReverseName(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, AssociationIdentification directionalName) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
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,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
CodingSchemeCopyRight getCodingSchemeCopyright(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
coding scheme.
LBException,
- InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
|
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 |