org.LexGrid.LexBIG.Extensions.Index
Interface IndexLoader

All Superinterfaces:
Extendable, Loader, java.io.Serializable

public interface IndexLoader
extends Loader

Manages registered index extensions. A single loader may be used to create and maintain multiple indexes over one or more coding schemes.

It is the responsibility of the loader to properly interpret each index it services by name, version, and provider.


Method Summary
 void clear(AbsoluteCodingSchemeVersionReference ref, Index index, boolean async)
          Remove index entries for the designated coding scheme.
 void load(AbsoluteCodingSchemeVersionReference ref, Index index, boolean stopOnErrors, boolean async)
          Load index entries for the designated coding scheme.
 void rebuild(AbsoluteCodingSchemeVersionReference ref, Index index, boolean async)
          Force (re)build of index entries for the designated coding scheme.
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Load.Loader
clearLog, getCodingSchemeManifest, getCodingSchemeManifestURI, getCodingSchemeReferences, getLoaderPreferences, getLog, getStatus, setCodingSchemeManifest, setCodingSchemeManifestURI, setLoaderPreferences, setLoaderPreferences
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable
getDescription, getName, getProvider, getVersion
 

Method Detail

clear

void clear(AbsoluteCodingSchemeVersionReference ref,
           Index index,
           boolean async)
           throws LBException
Remove index entries for the designated coding scheme.

Parameters:
ref - Reference to the target coding scheme. If null, indexes will be removed for all available content.
index - The index to be cleared. If null or empty, all indexes controlled by the loader are removed.
async - Flag controlling whether this operation occurs in the calling thread. If true, the load will occur in a separate asynchronous process. If false, this method blocks until the operation completes or fails. Regardless of setting, the getStatus and getLog calls are used to fetch results.
Throws:
LBInvocationException
LBException

load

void load(AbsoluteCodingSchemeVersionReference ref,
          Index index,
          boolean stopOnErrors,
          boolean async)
          throws LBException
Load index entries for the designated coding scheme. An exception is raised if resources cannot be accessed or another load operation is already in progress.

Parameters:
ref - Reference to the target coding scheme. If null, indexes will be created for all available content.
index - The index to be created. If null or empty, all indexes controlled by the loader are created.
stopOnErrors - True means stop if any load error is detected. False means attempt to load what can be loaded if recoverable errors are encountered.
async - Flag controlling whether this operation occurs in the calling thread. If true, the load will occur in a separate asynchronous process. If false, this method blocks until the operation completes or fails. Regardless of setting, the getStatus and getLog calls are used to fetch results.
Throws:
LBException

rebuild

void rebuild(AbsoluteCodingSchemeVersionReference ref,
             Index index,
             boolean async)
             throws LBException
Force (re)build of index entries for the designated coding scheme.

Parameters:
ref - Reference to the target coding scheme. If null, indexes will be rebuilt for all available content.
index - The index to be rebuilt. If null or empty, all indexes controlled by the loader are rebuilt.
async - Flag controlling whether this operation occurs in the calling thread. If true, the load will occur in a separate asynchronous process. If false, this method blocks until the operation completes or fails. Regardless of setting, the getStatus and getLog calls are used to fetch results.
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.