|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter
public class LexBIGServiceAdapter
Constructor Summary | |
---|---|
LexBIGServiceAdapter(LexBIGServiceGridAdapter adapter)
Entry point for connecting to the LexBIG caGrid Services. |
|
LexBIGServiceAdapter(java.lang.String url)
Entry point for connecting to the LexBIG caGrid Services. |
Method Summary | |
---|---|
CodedNodeSet |
getCodingSchemeConcepts(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Returns the set of all concepts in the specified coding scheme. |
CodedNodeSet |
getCodingSchemeConcepts(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
boolean activeOnly)
Returns the set of all (or all active) concepts in the specified coding scheme. |
Filter |
getFilter(java.lang.String 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(java.lang.String 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. |
HistoryService |
getHistoryService(java.lang.String 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. |
CodedNodeGraph |
getNodeGraph(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
java.lang.String relationsName)
Returns the node graph as represented in the particular relationship set in the coding scheme. |
CodedNodeSet |
getNodeSet(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag,
LocalNameList localNameList)
Returns the set of all entities in the specified coding scheme scheme of the given types. |
LexBIGServiceManager |
getServiceManager(java.lang.Object credentials)
Validate the credentials and return an interface to the LexBig service manager. |
LexBIGServiceMetadata |
getServiceMetadata()
Return an interface to perform system-wide query over metadata for loaded code systems and providers. |
Sort |
getSortAlgorithm(java.lang.String 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(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return detailed coding scheme information given a specific tag or version identifier. |
java.lang.String |
resolveCodingSchemeCopyright(java.lang.String codingScheme,
CodingSchemeVersionOrTag versionOrTag)
Return coding scheme copyright given a specific tag or version identifier. |
LexBIGService |
setSecurityToken(java.lang.String codingScheme,
SecurityToken token)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LexBIGServiceAdapter(java.lang.String url) throws LBInvocationException
url
- The URL of the LexBIG caGrid Service
LBInvocationException
public LexBIGServiceAdapter(LexBIGServiceGridAdapter adapter) throws LBInvocationException
adapter
- The adapter (Grid) of the LexBIG caGrid Service
LBInvocationException
Method Detail |
---|
public CodedNodeSet getCodingSchemeConcepts(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, boolean activeOnly) throws LBException
LexBIGService
getCodingSchemeConcepts
in interface LexBIGService
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.activeOnly
- True means node set consists only of concepts that are active
in the given version. False means set represents both active
and inactive concepts.
LBException
public CodedNodeSet getCodingSchemeConcepts(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGService
getCodingSchemeConcepts
in interface LexBIGService
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
public Filter getFilter(java.lang.String name) throws LBException
LexBIGService
getFilter
in interface LexBIGService
name
- The extension name; not null.
LBException
public ExtensionDescriptionList getFilterExtensions()
LexBIGService
getFilterExtensions
in interface LexBIGService
public GenericExtension getGenericExtension(java.lang.String name) throws LBException
LexBIGService
getGenericExtension
in interface LexBIGService
name
- The extension name; not null.
LBException
public ExtensionDescriptionList getGenericExtensions()
LexBIGService
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).
getGenericExtensions
in interface LexBIGService
public HistoryService getHistoryService(java.lang.String codingScheme) throws LBException
LexBIGService
getHistoryService
in interface LexBIGService
codingScheme
- The local name or URN of the coding scheme.
LBException
public java.util.Date getLastUpdateTime() throws LBInvocationException
LexBIGService
getLastUpdateTime
in interface LexBIGService
LBInvocationException
public ModuleDescriptionList getMatchAlgorithms()
LexBIGService
getMatchAlgorithms
in interface LexBIGService
public CodedNodeGraph getNodeGraph(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, java.lang.String relationsName) throws LBException
LexBIGService
getNodeGraph
in interface LexBIGService
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
public LexBIGServiceManager getServiceManager(java.lang.Object credentials) throws LBException
LexBIGService
getServiceManager
in interface LexBIGService
credentials
- Credentials - type to be determined by the security system;
null if not applicable.
LBException
public LexBIGServiceMetadata getServiceMetadata() throws LBException
LexBIGService
getServiceMetadata
in interface LexBIGService
LBException
public Sort getSortAlgorithm(java.lang.String name) throws LBException
LexBIGService
getSortAlgorithm
in interface LexBIGService
name
- The extension name; not null.
LBException
public SortDescriptionList getSortAlgorithms(SortContext context)
LexBIGService
Note: The returned list will include any 'built-in' sort algorithms in addition to extensions externally packaged and registered to the service.
getSortAlgorithms
in interface LexBIGService
context
- A context defined by the SortContext class, or null to
indicate that all registered algorithms are to be returned.
public CodingSchemeRenderingList getSupportedCodingSchemes() throws LBInvocationException
LexBIGService
getSupportedCodingSchemes
in interface LexBIGService
LBInvocationException
public CodingScheme resolveCodingScheme(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGService
resolveCodingScheme
in interface LexBIGService
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
public java.lang.String resolveCodingSchemeCopyright(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag) throws LBException
LexBIGService
resolveCodingSchemeCopyright
in interface LexBIGService
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
public CodedNodeSet getNodeSet(java.lang.String codingScheme, CodingSchemeVersionOrTag versionOrTag, LocalNameList localNameList) throws LBException
LexBIGService
getNodeSet
in interface LexBIGService
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.localNameList
- The list of entity types to resolve. Possible values
include the LexGrid built-in types "concept" and "instance".
Additional supported types can be defined uniquely to a
coding scheme. If null or empty, all entity types are
resolved.
LBException
public LexBIGService setSecurityToken(java.lang.String codingScheme, SecurityToken token) throws LBException
LBException
|
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 |