|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LexBIGServiceGrid
This interface represents the core interface to a LexBIG service.
Method Summary | |
---|---|
CodedNodeSetGrid |
getCodingSchemeConcepts(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns the set of all (or all active) concepts in the specified coding scheme. |
Filter |
getFilter(ExtensionIdentification name)
Returns an instance of the filter extension registered with the given name. |
ExtensionDescriptionList |
getFilterExtensions()
Returns a description of all registered extensions used to provide additional filtering of query results. |
GenericExtension |
getGenericExtension(ExtensionIdentification name)
Returns an instance of the application-specific extension registered with the given name. |
ExtensionDescriptionList |
getGenericExtensions()
Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService. |
HistoryServiceGrid |
getHistoryService(CodingSchemeIdentification codingScheme)
Resolve a reference to the history api servicing the given coding scheme. |
java.util.Date |
getLastUpdateTime()
Return the last time that the content of this service was changed; null if no changes have occurred. |
ModuleDescriptionList |
getMatchAlgorithms()
Returns the full description of all supported match algorithms. |
CodedNodeGraphGrid |
getNodeGraph(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag,
RelationContainerIdentification relationsName)
Returns the node graph as represented in the particular relationship set in the coding scheme. |
LexBIGServiceMetadataGrid<?> |
getServiceMetadata()
Return an interface to perform system-wide query over metadata for loaded code systems and providers. |
Sort |
getSortAlgorithm(ExtensionIdentification name)
Returns an instance of the sort extension registered with the given name. |
SortDescriptionList |
getSortAlgorithms(SortContext context)
Returns a description of all registered extensions used to provide additional sorting of query results in the given context. |
CodingSchemeRenderingList |
getSupportedCodingSchemes()
Return a list of coding schemes and versions that are supported by this service, along with their status. |
CodingScheme |
resolveCodingScheme(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return detailed coding scheme information given a specific tag or version identifier. |
CodingSchemeCopyRight |
resolveCodingSchemeCopyright(CodingSchemeIdentification codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return coding scheme copyright given a specific tag or version identifier. |
LexBIGServiceGrid |
setSecurityToken(CodingSchemeIdentification codingScheme,
SecurityToken token)
Registers a Security Token for a coding scheme |
Method Detail |
---|
CodedNodeSetGrid getCodingSchemeConcepts(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, 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 to query.
LBException,
- RemoteException
LBException
java.rmi.RemoteException
Filter getFilter(ExtensionIdentification name) throws java.rmi.RemoteException
name
- The extension name; not null.
java.rmi.RemoteException
ExtensionDescriptionList getFilterExtensions() throws java.rmi.RemoteException
java.rmi.RemoteException
GenericExtension getGenericExtension(ExtensionIdentification name) throws LBException, java.rmi.RemoteException
name
- The extension name; not null.
LBException
java.rmi.RemoteException
ExtensionDescriptionList getGenericExtensions() throws java.rmi.RemoteException
Note that only generic extensions (base class GenericExtension) will be listed here. All other classes are retrievable at the appropriate interface point (filter, sort, etc).
LBException,
- RemoteException
java.rmi.RemoteException
HistoryServiceGrid getHistoryService(CodingSchemeIdentification codingScheme) throws LBException, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.
LBException,
- RemoteException
LBException
java.rmi.RemoteException
java.util.Date getLastUpdateTime() throws LBInvocationException, java.rmi.RemoteException
LBInvocationException,
- RemoteException
LBInvocationException
java.rmi.RemoteException
ModuleDescriptionList getMatchAlgorithms() throws java.rmi.RemoteException
java.rmi.RemoteException
CodedNodeGraphGrid getNodeGraph(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag, RelationContainerIdentification relationsName) throws LBException, 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 to query.relationsName
- The name of the relations container to reference when generating
the graph. If omitted, all native relation containers for the code
system will be queried. Note: a 'native' container contains a
set of associations defined by the coding scheme curators.
LBException,
- RemoteException
LBException
java.rmi.RemoteException
LexBIGServiceMetadataGrid<?> getServiceMetadata() throws LBException, java.rmi.RemoteException
LBException,
- RemoteException
LBException
java.rmi.RemoteException
Sort getSortAlgorithm(ExtensionIdentification name) throws LBException, java.rmi.RemoteException
name
- The extension name; not null.
LBException,
- RemoteException
LBException
java.rmi.RemoteException
SortDescriptionList getSortAlgorithms(SortContext context) throws java.rmi.RemoteException
Note: The returned list will include any 'built-in' sort algorithms in addition to extensions externally packaged and registered to the service.
context
- A context defined by the SortContext class, or null to
indicate that all registered algorithms are to be returned.
java.rmi.RemoteException
CodingSchemeRenderingList getSupportedCodingSchemes() throws LBInvocationException, java.rmi.RemoteException
LBInvocationException,
- RemoteException
LBInvocationException
java.rmi.RemoteException
CodingScheme resolveCodingScheme(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
scheme to resolve.
LBException,
- RemoteException
LBException
java.rmi.RemoteException
CodingSchemeCopyRight resolveCodingSchemeCopyright(CodingSchemeIdentification codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.versionOrTag
- The assigned tag/label or absolute version identifier of the
scheme to resolve.
LBException,
- RemoteException
LBException
java.rmi.RemoteException
LexBIGServiceGrid setSecurityToken(CodingSchemeIdentification codingScheme, SecurityToken token) throws LBException, java.rmi.RemoteException
codingScheme
- The local name or URN of the coding scheme.token
- The assigned security token.
LBException,
- RemoteException
LBException
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 |