org.LexGrid.LexBIG.Extensions.Index
Interface Index

All Superinterfaces:
Extendable, java.io.Serializable

public interface Index
extends Extendable

Identifies expected behavior and an associated loader to build and maintain a named index. Note that a single loader may be used to maintain multiple named indexes.


Method Summary
 IndexLoader getLoader()
          Returns an object used to administer and maintain the Index.
 CodedNodeSet locateMatchingDesignations(CodedNodeSet baseSet, java.lang.String matchText, boolean preferredOnly, java.lang.String language)
          Return a coded node set containing all of the nodes that match the supplied criteria.
 CodedNodeSet locateMatchingProperties(CodedNodeSet baseSet, LocalNameList propertyList, java.lang.String matchText, java.lang.String language)
          Return a coded node set containing all of the nodes that match the supplied criteria.
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable
getDescription, getName, getProvider, getVersion
 

Method Detail

getLoader

IndexLoader getLoader()
Returns an object used to administer and maintain the Index.

Returns:
IndexLoader

locateMatchingDesignations

CodedNodeSet locateMatchingDesignations(CodedNodeSet baseSet,
                                        java.lang.String matchText,
                                        boolean preferredOnly,
                                        java.lang.String language)
                                        throws LBException
Return a coded node set containing all of the nodes that match the supplied criteria.

Parameters:
baseSet - Set of nodes to be searched.
matchText - Filter string
preferredOnly - True means match only preferred designations, false means all.
language - Filter language, where appropriate
Throws:
LBException

locateMatchingProperties

CodedNodeSet locateMatchingProperties(CodedNodeSet baseSet,
                                      LocalNameList propertyList,
                                      java.lang.String matchText,
                                      java.lang.String language)
                                      throws LBException
Return a coded node set containing all of the nodes that match the supplied criteria.

Parameters:
baseSet - Starting set to search
propertyList - List of properties to include in the match. Absent means all properties.
matchText - Text String to use in the match
language - Language code to match agains
Throws:
LBException

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.