org.LexGrid.LexBIG.cagrid.adapters
Class LexBIGServiceMetadataAdapter

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

public class LexBIGServiceMetadataAdapter
extends java.lang.Object
implements LexBIGServiceMetadata

See Also:
Serialized Form

Constructor Summary
LexBIGServiceMetadataAdapter(LexBIGServiceMetadataGridAdapter adapter)
           
 
Method Summary
 AbsoluteCodingSchemeVersionReferenceList listCodingSchemes()
          List the coding schemes that are represented in the metadata index.
 MetadataPropertyList resolve()
          Apply all of the restrictions, and return the result.
 LexBIGServiceMetadata restrictToCodingScheme(AbsoluteCodingSchemeVersionReference acsvr)
          Restrict the search to a particular coding scheme.
 LexBIGServiceMetadata restrictToProperties(java.lang.String[] properties)
          Restrict the search to a particular property.
 LexBIGServiceMetadata restrictToPropertyParents(java.lang.String[] propertyParents)
          Restrict the search by the parents of the metadata elements.
 LexBIGServiceMetadata restrictToValue(java.lang.String matchText, java.lang.String 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LexBIGServiceMetadataAdapter

public LexBIGServiceMetadataAdapter(LexBIGServiceMetadataGridAdapter adapter)
                             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException
Method Detail

listCodingSchemes

public AbsoluteCodingSchemeVersionReferenceList listCodingSchemes()
                                                           throws LBInvocationException
Description copied from interface: LexBIGServiceMetadata
List the coding schemes that are represented in the metadata index.

Specified by:
listCodingSchemes in interface LexBIGServiceMetadata
Throws:
LBInvocationException

resolve

public MetadataPropertyList resolve()
                             throws LBParameterException,
                                    LBInvocationException
Description copied from interface: LexBIGServiceMetadata
Apply all of the restrictions, and return the result.

Specified by:
resolve in interface LexBIGServiceMetadata
Returns:
Throws:
LBParameterException
LBInvocationException

restrictToCodingScheme

public LexBIGServiceMetadata restrictToCodingScheme(AbsoluteCodingSchemeVersionReference acsvr)
                                             throws LBParameterException
Description copied from interface: LexBIGServiceMetadata
Restrict the search to a particular coding scheme.

Specified by:
restrictToCodingScheme in interface LexBIGServiceMetadata
Parameters:
acsvr - The coding scheme to restrict the search to. You may provide the URN, the version, or both.
Throws:
LBParameterException

restrictToProperties

public LexBIGServiceMetadata restrictToProperties(java.lang.String[] properties)
                                           throws LBParameterException
Description copied from interface: LexBIGServiceMetadata
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 LexBIGServiceMetadata
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

restrictToPropertyParents

public LexBIGServiceMetadata restrictToPropertyParents(java.lang.String[] propertyParents)
                                                throws LBParameterException
Description copied from interface: LexBIGServiceMetadata
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 LexBIGServiceMetadata
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

restrictToValue

public LexBIGServiceMetadata restrictToValue(java.lang.String matchText,
                                             java.lang.String matchAlgorithm)
                                      throws LBParameterException
Description copied from interface: LexBIGServiceMetadata
Restrict the result to the metadata elements that match the supplied string, using the supplied matching algorithm

Specified by:
restrictToValue in interface LexBIGServiceMetadata
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

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.