|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceConvenienceMethodsGridAdapter
public class LexBIGServiceConvenienceMethodsGridAdapter
Constructor Summary | |
---|---|
LexBIGServiceConvenienceMethodsGridAdapter(LexBIGServiceConvenienceMethodsClient client)
|
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 associationName)
Return the coding schemes who supported association matching with AssociationIdentification. |
java.lang.String |
getDescription()
Return a description of the extension. |
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 resolveOption)
Return a representation of associations between a concept and hierarchical root node(s). |
ResolvedConceptReferenceList |
getHierarchyRoots(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag,
HierarchyIdentification hierarchyID)
Returns all root nodes for the given hierarchy and coding scheme. |
CodedNodeSetGrid |
getHierarchyRootSet(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag,
HierarchyIdentification hierarchyID)
Returns all root nodes for the given hierarchy as a CodeNodeSet, which can be further restricted. |
LexBIGServiceConvenienceMethods |
getLexBIGServiceConvenienceMethodsInterface()
|
java.lang.String |
getName()
Return the name assigned to this service extension. |
java.lang.String |
getProvider()
Return an identifier for the extension provider. |
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. |
java.lang.String |
getVersion()
Return version information about the extension. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LexBIGServiceConvenienceMethodsGridAdapter(LexBIGServiceConvenienceMethodsClient client) throws java.rmi.RemoteException
java.rmi.RemoteException
Method Detail |
---|
public CodedNodeSetGrid createCodeNodeSet(ConceptIdentification[] conceptCodes, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
createCodeNodeSet
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public AssociationIdentification[] getAssociationForwardAndReverseNames(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getAssociationForwardAndReverseNames
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public DirectionalAssociationIdentification getAssociationForwardName(AssociationIdentification association, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getAssociationForwardName
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public DirectionalAssociationIdentification[] getAssociationForwardNames(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getAssociationForwardNames
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public DirectionalAssociationIdentification getAssociationReverseName(AssociationIdentification association, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getAssociationReverseName
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public DirectionalAssociationIdentification[] getAssociationReverseNames(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getAssociationReverseNames
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public CodingSchemeRenderingList getCodingSchemesWithSupportedAssociation(AssociationIdentification associationName) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getCodingSchemesWithSupportedAssociation
in interface LexBIGServiceConvenienceMethodsGrid
associationName
- Association name to search for. It is case sensitive.
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
public HierarchyIdentification[] getHierarchyIDs(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
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 LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public AssociationList getHierarchyLevelNext(HierarchyResolutionPolicy policy, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getHierarchyLevelNext
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public AssociationList getHierarchyLevelPrev(HierarchyResolutionPolicy policy, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getHierarchyLevelPrev
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public AssociationList getHierarchyPathToRoot(HierarchyResolutionPolicy policy, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, HierarchyPathResolveOption resolveOption) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getHierarchyPathToRoot
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public CodedNodeSetGrid getHierarchyRootSet(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, HierarchyIdentification hierarchyID) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getHierarchyRootSet
in interface LexBIGServiceConvenienceMethodsGrid
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 getHierarchyIdentifications() method. If null, roots
for all registered hierarchies are returned.
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
public ResolvedConceptReferenceList getHierarchyRoots(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, HierarchyIdentification hierarchyID) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getHierarchyRoots
in interface LexBIGServiceConvenienceMethodsGrid
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 getHierarchyIdentifications() method. If null, roots
for all registered hierarchies are returned.
LBException
InvalidServiceContextAccess
java.rmi.RemoteException
public CodingSchemeRendering getRenderingDetail(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getRenderingDetail
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public CodeState isCodeRetired(ConceptIdentification conceptCode, CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
isCodeRetired
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public Direction isForwardName(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, AssociationIdentification directionalName) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
isForwardName
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public Direction isReverseName(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, AssociationIdentification directionalName) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
isReverseName
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public CodingSchemeCopyRight getCodingSchemeCopyright(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, InvalidServiceContextAccess, java.rmi.RemoteException
LexBIGServiceConvenienceMethodsGrid
getCodingSchemeCopyright
in interface LexBIGServiceConvenienceMethodsGrid
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
java.rmi.RemoteException
public java.lang.String getDescription()
Extendable
getDescription
in interface Extendable
public java.lang.String getName()
Extendable
getName
in interface Extendable
public java.lang.String getProvider()
Extendable
getProvider
in interface Extendable
public java.lang.String getVersion()
Extendable
getVersion
in interface Extendable
public LexBIGServiceConvenienceMethods getLexBIGServiceConvenienceMethodsInterface() throws java.lang.Exception
java.lang.Exception
|
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 |