org.LexGrid.LexBIG.Extensions.Load
Interface NCI_MetaThesaurusLoader

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

public interface NCI_MetaThesaurusLoader
extends Loader

Validates and/or loads the complete NCI MetaThesaurus. Content is supplied in RRF format files. If individual coding schemes are desired, use the UMLS_Loader instead.


Method Summary
 void load(java.net.URI source, boolean stopOnErrors, boolean async)
          Load content from a candidate resource.
 void recalcRootNodes(java.net.URI source, boolean async)
          Rebuild relationships between the system-designated top ('@') and end ('@@') nodes and those concepts linked to root hierarchical terms defined by the UMLS.
 void validate(java.net.URI source, int validationLevel)
          Validate content for a candidate resource without performing a load.
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Load.Loader
clearLog, getCodingSchemeManifest, getCodingSchemeManifestURI, getCodingSchemeReferences, getLoaderPreferences, getLog, getOntologyFormat, getOptions, getStatus, load, setCodingSchemeManifest, setCodingSchemeManifestURI, setLoaderPreferences, setLoaderPreferences
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable
getDescription, getName, getProvider, getVersion
 

Method Detail

load

void load(java.net.URI source,
          boolean stopOnErrors,
          boolean async)
          throws LBException
Load content from a candidate resource. This will also result in implicit generation of standard indices required by the LexBIG runtime. An exception is raised if resources cannot be accessed or another load operation is already in progress.

Parameters:
source - URI corresponding to the directory containing the MetaThesaurus files as provided by NCI.
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 load occurs in the calling thread. If true, the load will occur in a separate asynchronous process. If false, this method blocks until the load operation completes or fails. Regardless of setting, the getStatus and getLog calls are used to fetch results.
Throws:
LBException

recalcRootNodes

void recalcRootNodes(java.net.URI source,
                     boolean async)
                     throws LBException
Rebuild relationships between the system-designated top ('@') and end ('@@') nodes and those concepts linked to root hierarchical terms defined by the UMLS. This function is provided to allow re-evaluation of the root nodes in cases where the LexBIG algorithm has changed, without requiring a reload of the content. An exception is raised if resources cannot be accessed or another load operation is already in progress.

Parameters:
source - URI corresponding to the directory containing the MetaThesaurus files as provided by NCI.
async - Flag controlling whether load occurs in the calling thread. If true, the load will occur in a separate asynchronous process. If false, this method blocks until the load operation completes or fails. Regardless of setting, the getStatus and getLog calls are used to fetch results.
Throws:
LBException

validate

void validate(java.net.URI source,
              int validationLevel)
              throws LBException
Validate content for a candidate resource without performing a load. Returns without exception if validation succeeds.

Parameters:
source - URI corresponding to the directory containing the MetaThesaurus files as provided by NCI.
validationLevel - Loader-specific level of validation; 0 = verify all files are present and conform to the anticipated format.
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.