![]() |
Page History
...
The following table summarizes the operations available through the LexEVS Analytical Grid Service. Each of the operations is also defined in detail below. The grid analytical service and related operations are viewable via the caGrid Portal (http://cagrid-portal.nci.nih.gov).
ISO 21090 Model
The LexEVS 6.0 Analytical Grid Services use a version of the LexGRID/LexBIG model, extended to support ISO 21090 Datatypes.
The Click the adapted model may be found herelink.
Using the API
There are two (2) different interfaces for accessing the LexEVS Grid Services:
org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter
, ororg.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter
- Option 1, org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter provides an interface for interacting with the LexEVS Grid Services. This Interface is intended to mirror the existing LexEVS API as much as possible. There is no object wrapping for semantic purposes on this interface. This allows existing applications of the LexEVS API to use Grid Services without code changes.
This Interface may be acquired by instantiating LexBIGServiceAdapter with the Grid Service URL as a parameter.Code Block LexBIGService lbs = new LexBIGServiceAdapter ("http://lexevsapi-analytical60.nci.nih.gov/wsrf/services/cagrid/LexEVSGridService");
- Option 2, org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter also provides an interface for interacting with the LexEVS Grid Services. However, this Interfaces is the semantically defined interface. All method parameters and return values are defined and annotated as CDEs to be loaded into caDSR. This Interface is intended to be caGrid Silver Level Compliant.
This Interface may be acquired by instantiating LexBIGServiceGridAdapter with the Grid Service URL as a parameter.Code Block LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter ("http://lexevsapi-analytical60.nci.nih.gov/wsrf/services/cagrid/LexEVSGridService");
Method Descriptions
getCodingSchemeConcepts
getCodingSchemeConcepts(CodingSchemeIdentification, CodingSchemeVersionOrTag)
Description: | Returns the set of all (or all active) concepts in the specified coding scheme. |
Input: | org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag |
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.CodedNodeSet.stubs.types.CodedNodeSetReference |
Exception: | RemoteException |
Implementation Details: |
...
Input: | Implementation: |
Description: | Returns an instance of the filter extension registered with the given name. |
| Output: |
Description: | Returns an instance of the sort extension registered with the given name. |
Input: |
|
Exception: | RemoteException |
Implementation Details: |
getSortAlgorithm
|
| Output: | ''
|
Exception: | RemoteException | ||
Implementation Details: |
getFilterExtensions
| ||
Description: | Returns a description of all registered extensions used to provide additional filtering of query results. | |
Input: | none | |
Output |
| |
Exception: | RemoteException | |
Implementation Details: |
Implementation:
Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
Sample Call:
...
|
...
|
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
...
|
...
|
...
|
...
getServiceMetadata
getFilter
getFilter(ExtensionIdentification)
Description: | Returns an instance of the filter extension registered with the given name | Description: | Return an interface to perform system-wide query over metadata for loaded code systems and providers. |
Input: none | org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification | ||
Output: | org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.LexBIGServiceMetadataFilter. | ||
Exception: | RemoteException | ||
Implementation Details: | Implementation:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Sample Call:'
...
|
...
|
...
|
...
|
...
|
...
|
getSortAlgorithm
getSortAlgorithm(ExtensionIdentification)
Description: | Returns an instance of the sort extension registered with the given name. |
Input: | org |
LexBIGServiceMetadataGrid metadata = lbs.getServiceMetadata(); |
getSupportedCodingSchemes
Description: | Return a list of coding schemes and versions that are supported by this service, along with their status. |
Input: | none |
Output: | org.LexGrid.LexBIG.iso21090.DataModel.Collections.CodingSchemeRenderingListcagrid.ExtensionIdentification |
Output: | ''org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort. |
Exception: | RemoteException |
Implementation Details: | Implementation:
|
...
Sample Call:
...
|
...
|
...
|
...
|
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Step 2: Invoke the LexEVS caGrid service as follows:
CodingSchemeRenderingList csrl = lbs.getSupportedCodingSchemes(); |
getLastUpdateTime
...
Description:
...
Return the last time that the content of this service was changed; null if no changes have occurred. Tag assignments do not count as service changes for this purpose.
...
Input:
...
none
...
Output:
...
java.util.Date
...
Exception:
...
RemoteException
...
Implementation Details:
Implementation:
Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
Sample Call:
...
|
...
|
getFilterExtensions
getFilterExtensions()
Description: | Returns a description of all registered extensions used to provide additional filtering of query results. |
Input: | none |
Output |
Date date = lbs.getLastUpdateTime(); |
resolveCodingScheme
Description: | Return detailed coding scheme information given a specific tag or version identifier. |
Input: | org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification, org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag |
Output: | org.LexGrid.codingSchemes.CodingScheme |
Collections.ExtensionDescriptionList | |
Exception: | RemoteException |
Implementation Details: |
...
Input: | Implementation: |
Description: | Returns the node graph as represented in the particular relationship set in the coding scheme. |
Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
|
|
Output: | ''org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices. |
Exception: | RemoteException |
Implementation Details: |
getMatchAlgorithms
...
Description:
...
Returns the node graph as represented in the particular relationship set in the coding scheme.
...
Input:
...
none
...
Output:
...
org.LexGrid.LexBIG.iso21090.DataModel.Collections.ModuleDescriptionList
...
Exception:
...
RemoteException
...
Implementation Details:
|
Implementation:
Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
Sample Call:
...
|
...
|
...
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Step 2: Invoke the LexEVS caGrid service as follows:
ModuleDescriptionList mdl = lbs.getMatchAlgorithms(); |
getGenericExtensions
...
Description:
...
Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a 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). |
Input: | none | ||
Output: |
| ||
Exception: | RemoteException | ||
Implementation Details: |
Implementation:
Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
Sample Call:
Step 1: Connect to the LexEVS caGrid Service using the org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter or org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Step 2: Invoke the LexEVS caGrid service as follows:
ExtensionDescriptionList edl = lbs.getGenericExtensions(); |
getGenericExtension
...
Description:
...
Returns an instance of the application-specific extension registered with the given name.
...
Input:
...
org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification
...
Output:
...
org.LexGrid.LexBIG.iso21090.DataModel.Collections.SortDescriptionList
...
Exception:
...
RemoteException
...
Implementation Details:
getHistoryService
...
Description:
...
Resolve a reference to the history api servicing the given coding scheme.
...
Input:
...
org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification
...
Output:
...
org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.
HistoryService.stubs.types.HistoryServiceReference
...
Exception:
...
RemoteException
...
Implementation Details:
|
getSortAlgorithms
Description: | Returns a description of all registered extensions used to provide additional filtering of query results. | ||||
Input: |
| Output: |
|
CodingSchemeIdentification();
codingScheme.setCode(code);
Code Block |
---|
* _Step 3_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel. |
...
Exception:
...
RemoteException
...
Implementation Details:
Core.CodingSchemeVersionOrTag}} containing the Version information for the desired Coding Scheme.
|
CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion");
Code Block |
---|
* _Step 4_: Invoke the LexEVS caGrid service as follows:
|
CodingSchemeCopyRight copyright = lbs.resolveCodingSchemeCopyright(codingScheme, csvt);
Code Block |
---|
|
resolveCodingSchemeCopyright
...
Description:
...
Return coding scheme copyright given a specific tag or version identifier.
...
Input:
...
org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification
...
Output:
...
org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeCopyRight
...
Exception:
...
RemoteException
...
setSecurityToken
Description: | Sets the Security Token for the given Coding Scheme. |
Input: | org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification, gov.nih.nci.evs.security.SecurityToken |
Output: | org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LexEVSGridServiceReference.LexEVSGridServiceReference |
Exception: | RemoteException |
Implementation Details: |
...