org.LexGrid.LexBIG.cagrid.adapters
Class LexBIGServiceMetadataGridAdapter

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

public class LexBIGServiceMetadataGridAdapter
extends java.lang.Object
implements LexBIGServiceMetadataGrid

See Also:
Serialized Form

Constructor Summary
LexBIGServiceMetadataGridAdapter(LexBIGServiceMetadataClient client)
           
 
Method Summary
 org.LexGrid.LexBIG.LexBIGService.LexBIGServiceMetadata getLexBIGServiceMetadataInterface()
           
 org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList listCodingSchemes()
          List the coding schemes that are represented in the metadata index.
 org.LexGrid.LexBIG.DataModel.Collections.MetadataPropertyList resolve()
          Apply all of the restrictions, and return the result.
 LexBIGServiceMetadataGrid restrictToCodingScheme(org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference acsvr)
          Restrict the search to a particular coding scheme.
 LexBIGServiceMetadataGrid restrictToProperties(org.LexGrid.LexBIG.DataModel.cagrid.PropertyIdentification[] properties)
          Restrict the search to a particular property.
 LexBIGServiceMetadataGrid restrictToPropertyParents(org.LexGrid.LexBIG.DataModel.cagrid.PropertyIdentification[] propertyParents)
          Restrict the search by the parents of the metadata elements.
 LexBIGServiceMetadataGrid restrictToValue(org.LexGrid.LexBIG.DataModel.cagrid.MatchCriteria matchText, org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification matchAlgorithm)
          Restrict the result to the metadata elements that match the supplied string, using the supplied matching algorithm
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LexBIGServiceMetadataGridAdapter

public LexBIGServiceMetadataGridAdapter(LexBIGServiceMetadataClient client)
                                 throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException
Method Detail

listCodingSchemes

public org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList listCodingSchemes()
                                                                                                    throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                                                                                           org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                                           java.rmi.RemoteException
Description copied from interface: LexBIGServiceMetadataGrid
List the coding schemes that are represented in the metadata index.

Specified by:
listCodingSchemes in interface LexBIGServiceMetadataGrid
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

resolve

public org.LexGrid.LexBIG.DataModel.Collections.MetadataPropertyList resolve()
                                                                      throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                                             org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                                                             org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                             java.rmi.RemoteException
Description copied from interface: LexBIGServiceMetadataGrid
Apply all of the restrictions, and return the result.

Specified by:
resolve in interface LexBIGServiceMetadataGrid
Returns:
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToCodingScheme

public LexBIGServiceMetadataGrid restrictToCodingScheme(org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference acsvr)
                                                 throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                        org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                        java.rmi.RemoteException
Description copied from interface: LexBIGServiceMetadataGrid
Restrict the search to a particular coding scheme.

Specified by:
restrictToCodingScheme in interface LexBIGServiceMetadataGrid
Parameters:
acsvr - The coding scheme to restrict the search to. You may provide the URN, the version, or both.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToValue

public LexBIGServiceMetadataGrid restrictToValue(org.LexGrid.LexBIG.DataModel.cagrid.MatchCriteria matchText,
                                                 org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification matchAlgorithm)
                                          throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                 org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                 java.rmi.RemoteException
Description copied from interface: LexBIGServiceMetadataGrid
Restrict the result to the metadata elements that match the supplied string, using the supplied matching algorithm

Specified by:
restrictToValue in interface LexBIGServiceMetadataGrid
Parameters:
matchText - The match text. Format is determined by the match algorithm.
matchAlgorithm - Local name of the match algorithm - possible algorithms are returned in LexBigService.getMatchAlgorithms().
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToProperties

public LexBIGServiceMetadataGrid restrictToProperties(org.LexGrid.LexBIG.DataModel.cagrid.PropertyIdentification[] properties)
                                               throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                      org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                      java.rmi.RemoteException
Description copied from interface: LexBIGServiceMetadataGrid
Restrict the search to a particular property. Currently, this can be any element or attribute name from the OBO metadata schema. When we move to the 2006 version of the schema, there will be a method to get the available properties.

Specified by:
restrictToProperties in interface LexBIGServiceMetadataGrid
Parameters:
properties - The set of properties to restrict the search to. If you provide multiple properties, it is treated as an OR search.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToPropertyParents

public LexBIGServiceMetadataGrid restrictToPropertyParents(org.LexGrid.LexBIG.DataModel.cagrid.PropertyIdentification[] propertyParents)
                                                    throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                           org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                           java.rmi.RemoteException
Description copied from interface: LexBIGServiceMetadataGrid
Restrict the search by the parents of the metadata elements. The OBO MetaData format is hierarchial - if you wish to restrict your search to properties that are under another property, provide the required property containers here.

Specified by:
restrictToPropertyParents in interface LexBIGServiceMetadataGrid
Parameters:
propertyParents - The containers to require as parents. For example, to restrict the search to "contacts" that are under "about" that is under "authority" - provide "authority" and "about". The order of the parents does not matter. Multiple parents are treated as an AND - so the result is required to be under each of the parents going up the parent tree.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getLexBIGServiceMetadataInterface

public org.LexGrid.LexBIG.LexBIGService.LexBIGServiceMetadata getLexBIGServiceMetadataInterface()
                                                                                         throws java.lang.Exception
Returns:
Throws:
java.lang.Exception