org.LexGrid.LexBIG.cagrid.adapters
Class LexBIGServiceGridAdapter

java.lang.Object
  extended by org.LexGrid.LexBIG.cagrid.adapters.LexBIGServiceGridAdapter
All Implemented Interfaces:
java.io.Serializable, LexBIGServiceGrid

public class LexBIGServiceGridAdapter
extends java.lang.Object
implements LexBIGServiceGrid

See Also:
Serialized Form

Field Summary
private  LexEVSGridServiceClient lbSvc
           
 
Constructor Summary
LexBIGServiceGridAdapter(LexEVSGridServiceClient client)
          Entry point for connecting to the LexBIG caGrid Services.
LexBIGServiceGridAdapter(java.lang.String url)
          Entry point for connecting to the LexBIG caGrid Services.
 
Method Summary
 CodedNodeSetGrid getCodingSchemeConcepts(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Returns the set of all (or all active) concepts in the specified coding scheme.
 org.LexGrid.LexBIG.Extensions.Query.Filter getFilter(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
          Returns an instance of the filter extension registered with the given name.
 org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList getFilterExtensions()
          Returns a description of all registered extensions used to provide additional filtering of query results.
 org.LexGrid.LexBIG.Extensions.Generic.GenericExtension getGenericExtension(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
          Returns an instance of the application-specific extension registered with the given name.
 org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList getGenericExtensions()
          Returns a description of all registered extensions used to implement application-specific behavior that is centrally accessible from a LexBIGService.
 HistoryServiceGrid getHistoryService(org.LexGrid.LexBIG.DataModel.cagrid.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.
 org.LexGrid.LexBIG.LexBIGService.LexBIGService getLexBIGServiceInterface()
           
 org.LexGrid.LexBIG.DataModel.Collections.ModuleDescriptionList getMatchAlgorithms()
          Returns the full description of all supported match algorithms.
 CodedNodeGraphGrid getNodeGraph(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag, org.LexGrid.LexBIG.DataModel.cagrid.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.
 org.LexGrid.LexBIG.Extensions.Query.Sort getSortAlgorithm(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
          Returns an instance of the sort extension registered with the given name.
 org.LexGrid.LexBIG.DataModel.Collections.SortDescriptionList getSortAlgorithms(org.LexGrid.LexBIG.DataModel.InterfaceElements.types.SortContext context)
          Returns a description of all registered extensions used to provide additional sorting of query results in the given context.
 org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList getSupportedCodingSchemes()
          Return a list of coding schemes and versions that are supported by this service, along with their status.
 org.LexGrid.codingSchemes.CodingScheme resolveCodingScheme(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return detailed coding scheme information given a specific tag or version identifier.
 org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeCopyRight resolveCodingSchemeCopyright(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
          Return coding scheme copyright given a specific tag or version identifier.
 LexBIGServiceGrid setSecurityToken(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme, gov.nih.nci.evs.security.SecurityToken token)
          Registers a Security Token for a coding scheme
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lbSvc

private LexEVSGridServiceClient lbSvc
Constructor Detail

LexBIGServiceGridAdapter

public LexBIGServiceGridAdapter(java.lang.String url)
                         throws java.net.ConnectException,
                                org.apache.axis.types.URI.MalformedURIException
Entry point for connecting to the LexBIG caGrid Services.

Parameters:
url - The URL of the LexBIG caGrid Service
Throws:
LBInvocationException
java.net.ConnectException
org.apache.axis.types.URI.MalformedURIException

LexBIGServiceGridAdapter

public LexBIGServiceGridAdapter(LexEVSGridServiceClient client)
                         throws LBInvocationException
Entry point for connecting to the LexBIG caGrid Services.

Parameters:
client - The Client of the LexBIG caGrid Service
Throws:
LBInvocationException
Method Detail

resolveCodingScheme

public org.LexGrid.codingSchemes.CodingScheme resolveCodingScheme(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                  org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                           throws LBException,
                                                                  java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Return detailed coding scheme information given a specific tag or version identifier.

Specified by:
resolveCodingScheme in interface LexBIGServiceGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the scheme to resolve.
Throws:
LBException
java.rmi.RemoteException

getCodingSchemeConcepts

public CodedNodeSetGrid getCodingSchemeConcepts(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                         throws LBInvocationException,
                                                LBException,
                                                java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Returns the set of all (or all active) concepts in the specified coding scheme.

Specified by:
getCodingSchemeConcepts in interface LexBIGServiceGrid
Parameters:
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.
Throws:
LBInvocationException
LBException
java.rmi.RemoteException

getFilter

public org.LexGrid.LexBIG.Extensions.Query.Filter getFilter(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
                                                     throws LBException,
                                                            java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Returns an instance of the filter extension registered with the given name.

Specified by:
getFilter in interface LexBIGServiceGrid
Parameters:
name - The extension name; not null.
Returns:
org.LexGrid.LexBIG.Extensions.Query.Filter
Throws:
java.rmi.RemoteException
LBException

getGenericExtension

public org.LexGrid.LexBIG.Extensions.Generic.GenericExtension getGenericExtension(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
                                                                           throws LBException,
                                                                                  java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Returns an instance of the application-specific extension registered with the given name.

Specified by:
getGenericExtension in interface LexBIGServiceGrid
Parameters:
name - The extension name; not null.
Returns:
org.LexGrid.LexBIG.Extensions.Generic.GenericExtension
Throws:
LBException
java.rmi.RemoteException

getHistoryService

public HistoryServiceGrid getHistoryService(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme)
                                     throws LBException,
                                            java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Resolve a reference to the history api servicing the given coding scheme.

Specified by:
getHistoryService in interface LexBIGServiceGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
Returns:
org.LexGrid.LexBIG.History.HistoryService
Throws:
LBException
java.rmi.RemoteException

getNodeGraph

public CodedNodeGraphGrid getNodeGraph(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                       org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag,
                                       org.LexGrid.LexBIG.DataModel.cagrid.RelationContainerIdentification relationsName)
                                throws LBException,
                                       java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Returns the node graph as represented in the particular relationship set in the coding scheme.

Specified by:
getNodeGraph in interface LexBIGServiceGrid
Parameters:
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.
Throws:
LBException
java.rmi.RemoteException

getSortAlgorithm

public org.LexGrid.LexBIG.Extensions.Query.Sort getSortAlgorithm(org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification name)
                                                          throws LBException,
                                                                 java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Returns an instance of the sort extension registered with the given name.

Specified by:
getSortAlgorithm in interface LexBIGServiceGrid
Parameters:
name - The extension name; not null.
Returns:
org.LexGrid.LexBIG.Extensions.Query.Sort
Throws:
LBException
java.rmi.RemoteException

resolveCodingSchemeCopyright

public org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeCopyRight resolveCodingSchemeCopyright(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                                                                              org.LexGrid.LexBIG.DataModel.Core.CodingSchemeVersionOrTag versionOrTag)
                                                                                       throws LBException,
                                                                                              java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Return coding scheme copyright given a specific tag or version identifier.

Specified by:
resolveCodingSchemeCopyright in interface LexBIGServiceGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
versionOrTag - The assigned tag/label or absolute version identifier of the scheme to resolve.
Throws:
LBException
java.rmi.RemoteException

getFilterExtensions

public org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList getFilterExtensions()
Description copied from interface: LexBIGServiceGrid
Returns a description of all registered extensions used to provide additional filtering of query results.

Specified by:
getFilterExtensions in interface LexBIGServiceGrid
Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Filter and providing a public parameterless constructor.

getGenericExtensions

public org.LexGrid.LexBIG.DataModel.Collections.ExtensionDescriptionList getGenericExtensions()
                                                                                       throws java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
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).

Specified by:
getGenericExtensions in interface LexBIGServiceGrid
Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Generic.GenericExtension and providing a public parameterless constructor.
Throws:
java.rmi.RemoteException

getLastUpdateTime

public java.util.Date getLastUpdateTime()
                                 throws LBInvocationException,
                                        java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
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.

Specified by:
getLastUpdateTime in interface LexBIGServiceGrid
Returns:
java.util.Date
Throws:
LBInvocationException
java.rmi.RemoteException

getMatchAlgorithms

public org.LexGrid.LexBIG.DataModel.Collections.ModuleDescriptionList getMatchAlgorithms()
                                                                                  throws java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Returns the full description of all supported match algorithms.

Specified by:
getMatchAlgorithms in interface LexBIGServiceGrid
Throws:
java.rmi.RemoteException

getServiceMetadata

public LexBIGServiceMetadataGrid<?> getServiceMetadata()
                                                throws LBException,
                                                       java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Return an interface to perform system-wide query over metadata for loaded code systems and providers.

Specified by:
getServiceMetadata in interface LexBIGServiceGrid
Throws:
LBException
java.rmi.RemoteException

getSortAlgorithms

public org.LexGrid.LexBIG.DataModel.Collections.SortDescriptionList getSortAlgorithms(org.LexGrid.LexBIG.DataModel.InterfaceElements.types.SortContext context)
                                                                               throws LBException
Description copied from interface: LexBIGServiceGrid
Returns a description of all registered extensions used to provide additional sorting of query results in the given context.

Note: The returned list will include any 'built-in' sort algorithms in addition to extensions externally packaged and registered to the service.

Specified by:
getSortAlgorithms in interface LexBIGServiceGrid
Parameters:
context - A context defined by the SortContext class, or null to indicate that all registered algorithms are to be returned.
Returns:
The list containing the description of extensions registered for this category. Each description identifies a class of item implementing org.LexGrid.LexBIG.Extensions.Query.Sort and providing a public parameterless constructor.
Throws:
LBException

getSupportedCodingSchemes

public org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList getSupportedCodingSchemes()
                                                                                             throws LBInvocationException,
                                                                                                    java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Return a list of coding schemes and versions that are supported by this service, along with their status.

Specified by:
getSupportedCodingSchemes in interface LexBIGServiceGrid
Throws:
LBInvocationException
java.rmi.RemoteException

setSecurityToken

public LexBIGServiceGrid setSecurityToken(org.LexGrid.LexBIG.DataModel.cagrid.CodingSchemeIdentification codingScheme,
                                          gov.nih.nci.evs.security.SecurityToken token)
                                   throws LBException,
                                          java.rmi.RemoteException
Description copied from interface: LexBIGServiceGrid
Registers a Security Token for a coding scheme

Specified by:
setSecurityToken in interface LexBIGServiceGrid
Parameters:
codingScheme - The local name or URN of the coding scheme.
token - The assigned security token.
Throws:
LBException
java.rmi.RemoteException

getLexBIGServiceInterface

public org.LexGrid.LexBIG.LexBIGService.LexBIGService getLexBIGServiceInterface()
                                                                         throws java.lang.Exception
Throws:
java.lang.Exception