Error rendering macro 'rw-search'

null

Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

...

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:

Implementation:

Step 1: Create a Resource on the server and populate it with the requested org.LexGrid.LexBIG.LexBIGService.CodedNodeSet.
Step 2: Return the Client Reference to the user. This Reference has the above org.LexGrid.LexBIG.LexBIGService.CodedNodeSet as a Resource. An org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.service.CodedNodeSetClient object is built from the above Reference.

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.
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Step 2: Build a org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag containing the Version information for the desired Coding Scheme.
Code Block
CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion");
Step 3: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name.
Code Block
CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setCode(code);

Step 4: Invoke the LexBIG caGrid service as follows:

Code Block
CodedNodeSetGrid cns = lbs.getCodingSchemeConcepts(codingScheme, csvt);

...

Description:

Returns an instance of the filter extension registered with the given name.

Input:

org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification

Output:

org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Filter.stubs.types.FilterReference

Exception:

RemoteException

Implementation Details:

Implementation:

Step 1: Create a Resource on the server and populate it with the requested org.LexGrid.LexBIG.Extensions.Query.Filter.
Step 2: Return the Client Reference to the user. This Reference has the above org.LexGrid.LexBIG.Extensions.Query.Filter as a Resource. This client is a Service Context that allows the user to call regular org.LexGrid.LexBIG.Extensions.Query.Filter API calls through the grid service. An org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Filter.client.FilterClient object is built from the above Reference. This FilterClient implements the Interface org.LexGrid.LexBIG.Extensions.Query.Filter. This makes calling Grid Service Calls through org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Filter.client.FilterClient transparent to the end user.

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.
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Step 2: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification to hold the Extension name.
Code Block
ExtensionIdentification extension = new ExtensionIdentification(); extension.setLexBIGExtensionName(name);
Step 3: Invoke the LexEVS caGrid service as follows:
Code Block
Filter filter = lbs.getFilter(extension);

...

Description:

Returns an instance of the sort extension registered with the given name.

Input:

org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification

Output:

''org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort.
stubs.types.SortReference''

Exception:

RemoteException

Implementation Details:

Implementation:

Step 1: Create a Resource on the server and populate it with the requested org.LexGrid.LexBIG.Extensions.Query.Sort
Step 2: Return the Client Reference to the user. This Reference has the above org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort.client.SortClient as a Resource. This client is a Service Context that allows the user to call regular org.LexGrid.LexBIG.Extensions.Query.Sort API calls through the grid service. An org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort.client.SortClient object is built from the above Reference. This SortClient implements the Interface org.LexGrid.LexBIG.Extensions.Query.Sort. This makes calling Grid Service Calls through org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.Sort.client.SortClient transparent to the end user.

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.
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Step 2: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification to hold the Extension name.
Code Block
ExtensionIdentification extension = new ExtensionIdentification(); extension.setLexBIGExtensionName(name);
Step 3: Invoke the LexEVS caGrid service as follows:
Code Block
Filter filter = lbs.getSortAlgorithm(extension);

...

Description:

Returns a description of all registered extensions used to provide additional filtering of query results.

Input:

none

Output

org.LexGrid.LexBIG.iso21090.DataModel.Collections.ExtensionDescriptionList

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. * _Step
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
Step 2:_ Invoke the LexEVS caGrid service as follows: | h3. getServiceMetadata {{
Code Block
ExtensionDescriptionList extDescList = lbs.getFilterExtensions();
Code Block

getServiceMetadata

getServiceMetadata()

}} |

Description:

Return

interface

perform

system-wide

query

over

metadata

for

loaded

code

systems

and

providers.

| |

Input:

| _none_ | | Output: | _

none

Output:

org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.LexBIGServiceMetadata.

_ _

stubs.types.LexBIGServiceMetadataReference

_ | |

Exception:

RemoteException

Implementation Details:

Implementation:

Step 1: Create a Resource on the server and populate it with the requested | _RemoteException_ | | Implementation Details: | *_Implementation:_* * _Step 1:_ Create a Resource on the server and populate it with the requested {{org.LexGrid.LexBIG.LexBIGService.LexBIGServiceMetadata.
Step }}. * _Step 2:_ Return the LexBIGServiceMetadataClient to the user. This LexBIGServiceMetadataClient has the above {{org.LexGrid.LexBIG.LexBIGService.LexBIGServiceMetadata}} as as a Resource. An {{org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.service.LexBIGServiceMetadataClient}} object is built from the above Reference. | | | *_Sample

Sample Call:'

Step _*' * _Step 1:_ Connect to the LexEVS caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}. * _Step
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
Step 2:_ Invoke the LexEVS caGrid service as follows: | h3. getSupportedCodingSchemes {{
Code Block
LexBIGServiceMetadataGrid metadata = lbs.getServiceMetadata();
Code Block

getSupportedCodingSchemes

getSupportedCodingSchemes()

}} |

Description:

Return

list

coding

schemes

and

versions

that

are

supported

this

service,

along

with

their

status.

| |

Input:

none

Output:

| _none_ | | Output: | _

org.LexGrid.LexBIG.iso21090.DataModel.Collections.CodingSchemeRenderingList

_ | |

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 | _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}}. * _Step
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block

Step 2:_ Invoke the LexEVS caGrid service as follows:

Code Block
CodingSchemeRenderingList csrl = lbs.getSupportedCodingSchemes();
Code Block
\| h3. getLastUpdateTime {{

getLastUpdateTime

getLastUpdateTime()

}} |

Description:

Return

the

last

time

that

the

content

this

service

was

changed;

null

changes

have

occurred.

Tag

assignments

not

count

service

changes

for

this

purpose.

| |

Input:

none

Output:

| _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:

Step 1: Connect to the LexEVS caGrid Service using the _ | | 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}}. * _
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block

Step 2:_ Invoke the LexEVS caGrid service as follows:

Code Block
Date date = lbs.getLastUpdateTime();
Code Block
\| h3. resolveCodingScheme {{

resolveCodingScheme

resolveCodingScheme(CodingSchemeIdentification,

...

CodingSchemeVersionOrTag)

}} |

Description:

Return

detailed

coding

scheme

information

given

specific

tag

version

identifier.

| |

Input:

| _

org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification,

org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag

_ | |

Output:

| _

org.LexGrid.codingSchemes.CodingScheme

_ | |

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 | _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}}. * _
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
Step 2_: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name. * _Step 3_: Build a {{
Code Block
CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setCode(code);
Code Block
Step 3: Build a org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag}} containing the Version information for the desired Coding Scheme.
Code Block
CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion");
Code Block
* _Step 4_: Invoke the LexEVS caGrid service as follows:
CodedNodeSetGrid cns

Step 4: Invoke the LexEVS caGrid service as follows:

Code Block
CodedNodeSetGrid cns =

Code Block
lbs.resolveCodingScheme(codingScheme, csvt);
\| h3. getNodeGraph {{

getNodeGraph

getNodeGraph(CodingSchemeIdentification,

...

CodingSchemeVersionOrTag,

...

RelationContainerIdentification)

}} |

Description:

Returns

the

node

graph

represented

the

particular

relationship

set

the

coding

scheme.

| |

Input:

| _

org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification,

org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag,

org.LexGrid.LexBIG.iso21090.DataModel.cagrid.RelationContainerIdentification

_ | |

Output:

''org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.

CodedNodeGraph.stubs.types.CodedNodeGraphReference''

| |

Exception:

RemoteException

Implementation Details:

Implementation:

Step 1: Create a Resource on the server and populate it with the requested | _RemoteException_ | | Implementation Details: | _*Implementation*_: * _Step 1_: Create a Resource on the server and populate it with the requested {{org.LexGrid.LexBIG.LexBIGService.CodedNodeGraph}}. * _Step 2_: Return the .
Step 2: Return the Client Reference to the user. This Reference has the above Client Reference to the user. This Reference has the above {{org.LexGrid.LexBIG.LexBIGService.CodedNodeGraph}} as a Resource. An {{org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.service.CodedNodeGraphClient}} object is built from the above Reference. _*
Sample Call*_: * _Step 1_: Connect to :
Step 1: Connect to the LexBIG caGrid Service using the the LexBIG caGrid Service using the {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}. * _Step 2_: Build an
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
Step 2: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name. * _
Code Block
CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setCode(code);
Code Block
Step 3_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag}} containing the Version information for the desired Coding Scheme. * _
Code Block
CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion");
Code Block
Step 4_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel.cagrid.RelationContainerIdentification}} containing the Relation Container information. * _
Code Block
RelationContainerIdentification container = new RelationContainerIdentification(); container.setDc(name);
Code Block
Step 5_: Invoke the LexEVS caGrid service as follows, providing String parameters for the desired Coding Scheme and Relationship Name:
Code Block
CodedNodeGraphGrid cng = client.getNodeGraph(codingScheme, csvt, container);
Code Block
| h3. getMatchAlgorithms {{

getMatchAlgorithms

getMatchAlgorithms()

}} |

Description:

Returns

the

node

graph

represented

the

particular

relationship

set

the

coding

scheme.

| |

Input:

none

Output:

| _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:

Step 1: Connect to the LexEVS caGrid Service using the | _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}}. * _Step
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
Step 2:_ Invoke the LexEVS caGrid service as follows: | h3. getGenericExtensions {{getGenericExtensions()}} | Description: | Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService. {info:title=Note}nly generic extensions (base class GenericExtension) will be listed here. All other classes are retrievable at the appropriate interface point (filter, sort, etc).{info} | | Input: | _none_ | | Output: | _
Code Block
ModuleDescriptionList mdl = lbs.getMatchAlgorithms();
Code Block

getGenericExtensions

getGenericExtensions()

Description:

Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService.

Info

title	Note

nly 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:

org.LexGrid.LexBIG.iso21090.DataModel.Collections.ExtensionDescriptionList

_ | |

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 | _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}}. * _Step
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
Step 2:_ Invoke the LexEVS caGrid service as follows: | h3. getGenericExtension {{
Code Block
ExtensionDescriptionList edl = lbs.getGenericExtensions();
Code Block

getGenericExtension

getGenericExtensions(ExtensionIdentification)

}} |

Description:

Returns

instance

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:

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 | _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}}.
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
{info:=
Code Blockinfo
title
Note
}
Currently

this

method

will

return

a

LexBIGServiceConvenienceMethods

instance.
{info} * _Step 2_: Build an {{

Step 2: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.ExtensionIdentification}} to hold the Extension name. * _

Code Block
ExtensionIdentification extension = new ExtensionIdentification(); extension.setLexBIGExtensionName("LexBIGServiceConvenienceMethods");
Code Block

Step 3_: Invoke the LexEVS caGrid service as follows: * _

Code Block
LexBIGServiceConvenienceMethodsGrid lbscm = lbs.getGenericExtensions(extension);
Code Block

Step 4_: Return the {{LexBIGServiceConvenienceMethodsClient}} to the user. This LexBIGServiceConvenienceMethodsClient has the above {{org.LexGrid.LexBIG.Extensions.Generic.LexBIGServiceConvenienceMethods}} as a Resource. An {{org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.service.CodedNodeGraphClient}} object is built from the above Reference. | h3. getHistoryService {{

getHistoryService

getHistoryService(CodingSchemeIdentification)

}} |

Description:

Resolve

reference

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:

Implementation:

Step 1: Call this method on the associated LexEVS Service instance (or Distributed LexEVS instance) on the server, and forward the results.
Step 2: Return the HistoryServiceClient to the user. This HistoryServiceClient has the above | _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. * _Step 2_: Return the HistoryServiceClient to the user. This HistoryServiceClient has the above {{org.LexGrid.LexBIG.History.HistoryService}} as a Resource. This Client is a Service Context that allows the user to call regular {{org.LexGrid.LexBIG.History.HistoryService}} API calls through the grid service. HistoryServiceClient implements the Interface {{org.LexGrid.LexBIG.History.HistoryServic}}e. This makes calling Grid Service Calls through {{org.LexGrid.LexBIG.cagrid.LexBIGCaGridServices.HistoryService.client.HistoryServiceClient}} transparent to the end user. _*
Sample Call*_: * _Step 1_: Connect to the LexEVS caGrid Service using the {{org:
Step 1: Connect to the LexEVS caGrid Service using the org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceAdapter}} or {{org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter}}. * _Step 2_: Build an {{
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
Step 2: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification}} to hold the Coding Scheme name. * _
Code Block
CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setCode(code);
Code Block

Step 3_: Invoke the LexEVS caGrid service as follows:

Code Block
HistoryServiceGrid history = lbs.getHistoryService(codingScheme);
Code Block
\| h3. getSortAlgorithms {{

getSortAlgorithms

getSortAlgorithms(SortContext)

}} |

Description:

Returns

description

all

registered

extensions

used

provide

additional

filtering

query

results.

| |

Input:

| _

org.LexGrid.LexBIG.iso21090.DataModel.InterfaceElements.types.SortContext

_ | |

Output:

| _

org.LexGrid.LexBIG.iso21090.DataModel.Collections.SortDescriptionList

_ | |

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 | _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
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
* _Step 2_: Invoke the LexEVS caGrid service as follows:
SortDescriptionList sortDescList =

Step 2: Invoke the LexEVS caGrid service as follows:

Code Block
SortDescriptionList sortDescList = lbs.getSortAlgorithms(sortContext);
Code Block
\| h3. resolveCodingSchemeCopyright {{

resolveCodingSchemeCopyright

resolveCodingSchemeCopyright(CodingSchemeIdentification)

Description:

Return coding scheme copyright given a specific tag or version identifier.

Input:

}} | 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

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 | _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}}. * _
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Code Block
Step 2_: Build an {{org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification}} to hold the Coding Scheme name.
Code Block
CodingSchemeIdentification codingScheme = new
CodingSchemeIdentification();

...

codingScheme.setCode(code);

...

Step 3: Build an org.LexGrid.LexBIG.iso21090.DataModel.Core.CodingSchemeVersionOrTag

...

containing

...

Version

...

information

...

desired

...

Coding

...

Scheme.
Code Block

...

CodingSchemeVersionOrTag csvt = new CodingSchemeVersionOrTag(); csvt.setVersion("testVersion");

...

Step 4: Invoke the LexEVS caGrid service as follows:
Code Block
CodingSchemeCopyRight copyright =

Code Block
* _Step 4_: Invoke the LexEVS caGrid service as follows:

...

lbs.resolveCodingSchemeCopyright(codingScheme, csvt);

...

setSecurityToken

setSecurityToken(CodingSchemeIdentification, SecurityToken)

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

gov.nih.nci.evs.security.SecurityToken

Output:

org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LexEVSGridServiceReference.LexEVSGridServiceReference

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.
Code Block
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);
Step 2: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name.
Code Block
CodingSchemeIdentification codingScheme = new CodingSchemeIdentification(); codingScheme.setName("codingScheme");
Step 3: Build an gov.nih.nci.evs.security.SecurityToken containing the security information for the desired Coding Scheme.
Code Block
SecurityToken metaToken = new SecurityToken(); metaToken.setAccessToken("token");
Step 4: Invoke the LexEVS caGrid service as follows: This will return a reference to a new "LexBIGServiceGrid" instance that is associated with the security properties that were passed in.
Code Block
LexBIGServiceGrid lbsg = lbs.setSecurityToken(codingScheme, metaToken);

Implementation Details:

Usage Instructions

Service URL

...

The libraries required for programmatic access to the LexEVS Grid Service are listed in the tables below. The 3rd Party Software Libraries required for use of the LexEVS API Grid Service are listed in Table 4.1 and the NCICB software captured under the caBIG® umbrella are listed in Table 4.2.Table 4.1 3rd Party Librariesthe following table.

Product

Jars

License

Home Page

Apache WS-Addressing

addressing-1.0.jar

adressing 1.0.LICENSE

From Globus 4.0.2 Java Web Services Core lib directory:

http://www.globus.org/toolkit/downloads/4.0.2

Source available at

http://ws.apache.org/addressing^{Image Modified}

...


Apache Axis	axis-ant.jar axis.jar commons-pool-1.3.jar commons-logging-1.1.jar commons-lang-2.2.jar commons-collections-3.2.jar commons-codec-1.3.jar log4j-1.2.8.jar jaxrpc.jar saaj.jar wsdl4j.jar

...

axis-jars.LICENSE

...

http://ws.apache.org/axis^{Image Modified}

...


Apache Xerces	xercesImpl.jar	xerces.LICENSE	http://xerces.apache.org/xerces-j
Apache Lucene	lucene-core-2.3.2.jar lucene-regex-2.3.2.jar lucene-snowball-2.3.2.jar

...

Lucene LICENSE

...

http://lucene.apache.org/^{Image Modified}

...


ASM - all purpose Java bytecode manipulation and analysis framework	asm.jar	http://asm.objectweb.org/license.html	http://asm.objectweb.org/
Castor	castor-1.2.jar	http://www.castor.org/license.html	http://www.castor.org/index.html
Globus Toolkit	cog-axis.jar cog-jglobus.jar

...

http://www.globus.org/toolkit/legal/4.0/^{Image Modified}

...


Bouncy Castle Crypto APIs	jce-jdk13-125.jar	http://www.bouncycastle.org/licence.html	http://www.bouncycastle.org/
Open Permis	wsrf_core.jar wsrf_core_stubs.jar

...

http://www.openpermis.org/BSDlicenceKent.txt^{Image Modified}

...

http://www.openpermis.org/^{Image Modified}

...


Apache WSS4J	wss4j.jar	http://ws.apache.org/wss4j/license.html	http://ws.apache.org/wss4j/
Spring	spring.jar	Spring LICENSE	http://www.springframework.org

Table 4.2 NCICB/caBIG LibrariesThe NCICB software captured under the caBIG® umbrella are listed in the following table.

Library	Associated JARs
caGrid Software Libraries	caGrid-ServiceSecurityProvider-client-1.2.jar
caGrid-ServiceSecurityProvider-common-1.2.jar
caGrid-ServiceSecurityProvider-stubs-1.2.jar
caGrid-core-1.2.jar
caGrid-metadata-common-1.2.jar
caGrid-metadata-data-1.2.jar
caGrid-metadata-security-1.2.jar
caGrid-metadatautils-1.2.jar
EVS API Libaries	evsapi42-beans.jar
evsapi42-framework.jar
LexEVS Grid Service Client Library	LexEVSGridService-client.jar
LexEVS Grid Service Stubs	LexEVSGridService-stubs.jar
LexEVS Grid Service Common	LexEVSGridService-common.jar
LexEVS Grid Service Service	LexEVSGridService-service.jar
LexEVS Grid Service Tests	LexEVSGridService-tests.jar
caCORE SDK Library	sdk-client-framework.jar
LexEVS API	lexbig.jar
Custom Castor Serializer	castor-bean-serializer.jar

...

For your convenience, the required libraries are available for download here:

https://gforge.nci.nih.gov/docman/view.php/491/14401/lexevs42-gridsrvc-jars.jar^{Image Removed}. required libraries

In order to programmatically access the LexEVS API Grid Service, these libraries need to be added to your local classpath.

Code Examples

Example

...

Client and

...

Service Calls, and SOAP

...

Messages

See zip file.See http://gforge.nci.nih.gov/docman/view.php/491/14252/TestClient.zip^{Image Removed}

Example API usage

Example 1: Searching for concepts in NCI Thesaurus containing the string "Gene."

Include Page

	LexEVS:SearchingForConcepts_Snippet
	LexEVS:SearchingForConcepts_Snippet

Error Handling

Error Connecting to LexEVS Grid Service

...

If the URL is well-formed, proper connection is tested. If the connection attempt fails, a ConnectException is thrown containing the reason for the failure.

Include Page

	LexEVS:LexGridServiceConnection_Snippet
	LexEVS:LexGridServiceConnection_Snippet

This example shows a typical connection to the LexEVS Grid Service, with the two potential Exceptions being caught and handled as necessary.

...

Service Context Services are not meant to be called directly. If the client attempts to do so, an org.LexGrid.LexBIG.cagrid.LexEVSGridService.CodedNodeSet.stubs.types.InvalidServiceContextAccess Exception will be thrown. This indicates a call was made to a Service Context without obtaining a Service Context Reference via the Main Service (see the above section Service Contexts and State for more information).

Security Issues

LexEVS Grid Service Security

Certain vocabulary content accessible through the LexEVS Grid Service may require extra authorization to access. Each client is required to supply its own access credentials via Security Tokens. These Security Tokens are implemented by a SecurityToken object:

Name: SecurityToken
Namespace: gme://caCORE.caCORE/3.2/gov.nih.nci.evs.security
Package: gov.nih.nci.evs.security

Accessing Secure Content

A client establishes access to a secured vocabulary via the following Grid Service Calls:

Step 1: Connect to the LexEVS caGrid Service
LexBIGServiceGrid lbs = new LexBIGServiceGridAdapter(url);

Step 2: Build an org.LexGrid.LexBIG.iso21090.DataModel.cagrid.CodingSchemeIdentification to hold the Coding Scheme name.

Code Block
CodingSchemeIdentification <font color="000FFF">codingScheme</font> = <font color="990066">new</font> CodingSchemeIdentification();

...


codingScheme.setName(<font color="000FFF">"codingScheme"</font>);

Step 3: Build an gov.nih.nci.evs.security.SecurityToken containing the security information for the desired Coding Scheme.
SecurityToken token = new SecurityToken ();
token.setAccessToken("securityToken");
Step 4: Invoke the LexEVS caGrid service as follows: This will return a reference to a new "LexBIGServiceGrid" instance that is associated with the security properties that were passed in.
Code Block
LexBIGServiceGrid lbsg = lbs.setSecurityToken(codingScheme, token);
It is important to note that the Grid Service "setSecurityToken" returns an

...

{{org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types
.LexEVSGridServiceReference.LexEVSGridServiceReference

...

}}
object. This reference must be used to access the secured vocabularies.

Implementation

Each call to "setSecurityToken" sets up a secured connection to Distributed LexEVS with the access privileges included in the SecurityToken parameter. The LexEVSGridServiceReference that is returned to the client contains a unique key identifier to the secure connection that has been created on the server. All subsequent calls the client makes through this LexEVSGridServiceReference will be made securely. If additional SecurityTokens are passed in through the "setSecurityToken" Grid Service, the additional security will be added and maintained.

...

If no SecurityTokens are passed in by the client, a non-secure Distributed LexEVS connection will be used. The server maintains one (and only one) un-secured Distributed LexEVS connection that is shared by any client not requesting security.NOTE:

Info

title	Note

All non-secured information accessed by the LexEVS Grid Service is publicly available from NCICB and users are expected to follow the licensing requirements currently in place for accessing and using NCI EVS information.

Scrollbar

icons	false

Content

Space Tools

Versions Compared

Old Version 4

New Version 5

Key

getServiceMetadata

getSupportedCodingSchemes

getLastUpdateTime

resolveCodingScheme

getNodeGraph

getMatchAlgorithms

getGenericExtensions

getGenericExtension

getHistoryService

getSortAlgorithms

resolveCodingSchemeCopyright

setSecurityToken

Usage Instructions

Service URL

Code Examples

Example

Client and

Service Calls, and SOAP

Messages

Example API usage

Error Handling

Error Connecting to LexEVS Grid Service

Security Issues

LexEVS Grid Service Security

Accessing Secure Content

Implementation