org.LexGrid.LexBIG.cagrid.interfaces
Interface LexBIGServiceMetadataGrid<LexBIGServiceMetadataImpl>

Type Parameters:
LexBIGServiceMetadataImpl -
All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
LexBIGServiceMetadataGridAdapter

public interface LexBIGServiceMetadataGrid<LexBIGServiceMetadataImpl>
extends java.io.Serializable

Interface to perform system-wide query over metadata for loaded code systems and providers.


Method Summary
 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
 

Method Detail

listCodingSchemes

org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList listCodingSchemes()
                                                                                                    throws LBInvocationException,
                                                                                                           InvalidServiceContextAccess,
                                                                                                           java.rmi.RemoteException
List the coding schemes that are represented in the metadata index.

Throws:
LBParameterException, - InvalidServiceContextAccess, RemoteException
LBInvocationException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToCodingScheme

LexBIGServiceMetadataGrid<?> restrictToCodingScheme(org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference acsvr)
                                                    throws LBParameterException,
                                                           InvalidServiceContextAccess,
                                                           java.rmi.RemoteException
Restrict the search to a particular coding scheme.

Parameters:
acsvr - The coding scheme to restrict the search to. You may provide the URN, the version, or both.
Throws:
LBParameterException, - InvalidServiceContextAccess, RemoteException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToProperties

LexBIGServiceMetadataGrid<?> restrictToProperties(org.LexGrid.LexBIG.DataModel.cagrid.PropertyIdentification[] properties)
                                                  throws LBParameterException,
                                                         InvalidServiceContextAccess,
                                                         java.rmi.RemoteException
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.

Parameters:
properties - The set of properties to restrict the search to. If you provide multiple properties, it is treated as an OR search.
Throws:
LBParameterException, - InvalidServiceContextAccess, RemoteException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToPropertyParents

LexBIGServiceMetadataGrid<?> restrictToPropertyParents(org.LexGrid.LexBIG.DataModel.cagrid.PropertyIdentification[] propertyParents)
                                                       throws LBParameterException,
                                                              InvalidServiceContextAccess,
                                                              java.rmi.RemoteException
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.

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:
LBParameterException, - InvalidServiceContextAccess, RemoteException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToValue

LexBIGServiceMetadataGrid<?> restrictToValue(org.LexGrid.LexBIG.DataModel.cagrid.MatchCriteria matchText,
                                             org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification matchAlgorithm)
                                             throws LBParameterException,
                                                    InvalidServiceContextAccess,
                                                    java.rmi.RemoteException
Restrict the result to the metadata elements that match the supplied string, using the supplied matching algorithm

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:
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

resolve

org.LexGrid.LexBIG.DataModel.Collections.MetadataPropertyList resolve()
                                                                      throws LBParameterException,
                                                                             LBInvocationException,
                                                                             InvalidServiceContextAccess,
                                                                             java.rmi.RemoteException
Apply all of the restrictions, and return the result.

Returns:
Throws:
LBParameterException, - LBInvocationException, InvalidServiceContextAccess, RemoteException
LBParameterException
LBInvocationException
InvalidServiceContextAccess
java.rmi.RemoteException