org.LexGrid.LexBIG.LexBIGService
Interface LexBIGServiceMetadata

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
LexBIGServiceMetadataAdapter, LexBIGServiceMetadataImpl

public interface LexBIGServiceMetadata
extends java.io.Serializable

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


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
 

Method Detail

listCodingSchemes

AbsoluteCodingSchemeVersionReferenceList listCodingSchemes()
                                                           throws LBInvocationException
List the coding schemes that are represented in the metadata index.

Throws:
LBInvocationException

restrictToCodingScheme

LexBIGServiceMetadata restrictToCodingScheme(AbsoluteCodingSchemeVersionReference acsvr)
                                             throws LBParameterException
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

restrictToProperties

LexBIGServiceMetadata restrictToProperties(java.lang.String[] properties)
                                           throws LBParameterException
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

restrictToPropertyParents

LexBIGServiceMetadata restrictToPropertyParents(java.lang.String[] propertyParents)
                                                throws LBParameterException
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

restrictToValue

LexBIGServiceMetadata restrictToValue(java.lang.String matchText,
                                      java.lang.String matchAlgorithm)
                                      throws LBParameterException
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

resolve

MetadataPropertyList resolve()
                             throws LBParameterException,
                                    LBInvocationException
Apply all of the restrictions, and return the result.

Returns:
Throws:
LBParameterException
LBInvocationException

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.