org.LexGrid.LexBIG.cagrid.interfaces
Interface LexBIGServiceConvenienceMethodsGrid

All Known Implementing Classes:
LexBIGServiceConvenienceMethodsGridAdapter

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

createCodeNodeSet

CodedNodeSetGrid createCodeNodeSet(ConceptIdentification[] conceptCodes,
                                   CodingSchemeIdentification codingScheme,
                                   CodingSchemeVersionOrTag versionOrTag)
                                   throws LBException,
                                          InvalidServiceContextAccess,
                                          java.rmi.RemoteException
Create a CodedNodeSet from a set of concept codes in a coding scheme.

Parameters:
conceptCodes - The concept codes for included items.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
A CodedNodeSet representing the corresponding coded entries.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyIDs

HierarchyIdentification[] getHierarchyIDs(CodingSchemeIdentification codingScheme,
                                          CodingSchemeVersionOrTag versionOrTag)
                                          throws LBException,
                                                 InvalidServiceContextAccess,
                                                 java.rmi.RemoteException
Returns the identifiers for hierarchical relationships available for navigation within a coding scheme. These identifiers can be submitted to the getHierarchyBroader() or getHierarchyNarrower() methods to navigate corresponding tree structures.

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

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The array of identifiers; empty if no hierarchies are explicitly defined (the ontology is 'flat').
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyRoots

ResolvedConceptReferenceList getHierarchyRoots(CodingSchemeIdentification codingScheme,
                                               CodingSchemeVersionOrTag versionOrTag,
                                               HierarchyIdentification hierarchyIdentification)
                                               throws LBException,
                                                      InvalidServiceContextAccess,
                                                      java.rmi.RemoteException
Returns all root nodes for the given hierarchy and coding scheme. Each root concept represents the conceptual start or narrowest point of a tree when visualizing the hierarchy.

Parameters:
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.
Returns:
The collection of references to root nodes; empty if the given hierarchy is not recognized or is unfulfilled by the given coding scheme and version.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyRootSet

CodedNodeSetGrid getHierarchyRootSet(CodingSchemeIdentification codingScheme,
                                     CodingSchemeVersionOrTag versionOrTag,
                                     HierarchyIdentification hierarchyIdentification)
                                     throws LBException,
                                            InvalidServiceContextAccess,
                                            java.rmi.RemoteException
Returns all root nodes for the given hierarchy as a CodeNodeSet, which can be further restricted. Each root concept represents the conceptual start or narrowest point of a tree when visualizing the hierarchy.

Parameters:
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.
Returns:
The collection of references to root nodes; empty if the given hierarchy is not recognized or is unfulfilled by the given coding scheme and version.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyLevelNext

AssociationList getHierarchyLevelNext(HierarchyResolutionPolicy policy,
                                      CodingSchemeIdentification codingScheme,
                                      CodingSchemeVersionOrTag versionOrTag)
                                      throws LBException,
                                             InvalidServiceContextAccess,
                                             java.rmi.RemoteException
Return a representation of associations between a concept and its immediate decendents. The resolved association list represents the next branch of the hierarchy when visualized in a top (root) to bottom (leaf) representation.

Parameters:
policy - Policy for resolving the hierarchy
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The list of associations and referenced concepts representing immediate decendents within the hierarchy; empty if no items are found.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyLevelPrev

AssociationList getHierarchyLevelPrev(HierarchyResolutionPolicy policy,
                                      CodingSchemeIdentification codingScheme,
                                      CodingSchemeVersionOrTag versionOrTag)
                                      throws LBException,
                                             InvalidServiceContextAccess,
                                             java.rmi.RemoteException
Return a representation of associations between a concept and its immediate ancestor(s). The resolved association list represents the previous level of the hierarchy when visualized in a top (root) to bottom (leaf) representation.

Parameters:
policy - Policy for resolving the CodedNodeSet
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The list of associations and referenced concepts representing the immediate ancestor(s) within the hierarchy; empty if no items are found.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getHierarchyPathToRoot

AssociationList getHierarchyPathToRoot(HierarchyResolutionPolicy policy,
                                       CodingSchemeIdentification codingScheme,
                                       CodingSchemeVersionOrTag versionOrTag,
                                       HierarchyPathResolveOption pathResolveOption)
                                       throws LBException,
                                              InvalidServiceContextAccess,
                                              java.rmi.RemoteException
Return a representation of associations between a concept and hierarchical root node(s). The resolved association list represents the path within the hierarchy from traversed from bottom (leaf) to top (root).

Parameters:
policy - Policy for resolving the CodedNodeSet
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Returns:
The list of associations and referenced concepts representing the path to root node(s) within the hierarchy; empty if no items are found. If not empty, each association in the initial list represents a separate path to root for the given concept.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getRenderingDetail

CodingSchemeRendering getRenderingDetail(CodingSchemeIdentification codingScheme,
                                         CodingSchemeVersionOrTag versionOrTag)
                                         throws LBException,
                                                InvalidServiceContextAccess,
                                                java.rmi.RemoteException
Return detailed rendering information (including coding scheme summary, version and status information, reference links, etc) for the given coding scheme; null if not available.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

isCodeRetired

CodeState isCodeRetired(ConceptIdentification conceptCode,
                        CodingSchemeIdentification codingScheme,
                        CodingSchemeVersionOrTag versionOrTag)
                        throws LBException,
                               InvalidServiceContextAccess,
                               java.rmi.RemoteException
Indicates if the given code is considered retired or inactive within context of the provided scheme.

Parameters:
conceptCode - The concept code to evaluate.
codingScheme - The local name or URN of the coding scheme to query.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme to query.
Returns:
true if retired; false otherwise
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getCodingSchemesWithSupportedAssociation

CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(AssociationIdentification AssociationIdentification)
                                                                   throws LBException,
                                                                          InvalidServiceContextAccess,
                                                                          java.rmi.RemoteException
Return the coding schemes who supported association matching with AssociationIdentification. The search is performed only for loaded coding schemes.

Parameters:
AssociationIdentification - Association name to search for. It is case sensitive.
Returns:
List of coding schemes who has supported association matching with the value of AssociationIdentification
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationForwardAndReverseNames

AssociationIdentification[] getAssociationForwardAndReverseNames(CodingSchemeIdentification codingScheme,
                                                                 CodingSchemeVersionOrTag versionOrTag)
                                                                 throws LBException,
                                                                        InvalidServiceContextAccess,
                                                                        java.rmi.RemoteException
Return all the association forward name and reverse name for the coding scheme.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationForwardName

DirectionalAssociationIdentification getAssociationForwardName(AssociationIdentification association,
                                                               CodingSchemeIdentification codingScheme,
                                                               CodingSchemeVersionOrTag versionOrTag)
                                                               throws LBException,
                                                                      InvalidServiceContextAccess,
                                                                      java.rmi.RemoteException
Return the forward name for the identified association.

Parameters:
association - Primary name of the association.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationForwardNames

DirectionalAssociationIdentification[] getAssociationForwardNames(CodingSchemeIdentification codingScheme,
                                                                  CodingSchemeVersionOrTag versionOrTag)
                                                                  throws LBException,
                                                                         InvalidServiceContextAccess,
                                                                         java.rmi.RemoteException
Return all the association forward name for the coding scheme.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationReverseName

DirectionalAssociationIdentification getAssociationReverseName(AssociationIdentification association,
                                                               CodingSchemeIdentification codingScheme,
                                                               CodingSchemeVersionOrTag versionOrTag)
                                                               throws LBException,
                                                                      InvalidServiceContextAccess,
                                                                      java.rmi.RemoteException
Return the reverse name for the identified association.

Parameters:
association - Basic (non-directional) name of the association.
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getAssociationReverseNames

DirectionalAssociationIdentification[] getAssociationReverseNames(CodingSchemeIdentification codingScheme,
                                                                  CodingSchemeVersionOrTag versionOrTag)
                                                                  throws LBException,
                                                                         InvalidServiceContextAccess,
                                                                         java.rmi.RemoteException
Return all the association reverse name for the coding scheme.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

isForwardName

Direction isForwardName(CodingSchemeIdentification codingScheme,
                        CodingSchemeVersionOrTag versionOrTag,
                        AssociationIdentification directionalName)
                        throws LBException,
                               InvalidServiceContextAccess,
                               java.rmi.RemoteException
Return true if directionalName is the forward name of an association for the coding scheme.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
directionalName - The directionalName string
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

isReverseName

Direction isReverseName(CodingSchemeIdentification codingScheme,
                        CodingSchemeVersionOrTag versionOrTag,
                        AssociationIdentification directionalName)
                        throws LBException,
                               InvalidServiceContextAccess,
                               java.rmi.RemoteException
Return true if directionalName is the reverse name of an association for the coding scheme.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
directionalName - The directionalName string
Throws:
LBException, - InvalidServiceContextAccess, RemoteException
LBException
InvalidServiceContextAccess
java.rmi.RemoteException

getCodingSchemeCopyright

CodingSchemeCopyRight getCodingSchemeCopyright(CodingSchemeIdentification codingScheme,
                                               CodingSchemeVersionOrTag versionOrTag)
                                               throws LBException,
                                                      InvalidServiceContextAccess,
                                                      java.rmi.RemoteException
Return the copyright text for the coding scheme.

Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the coding scheme.
Throws:
LBException, - 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.