org.LexGrid.LexBIG.Extensions.Load
Interface Text_Loader

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

public interface Text_Loader
extends Loader

A loader for delimited text type files. Text files come in one of two formats: A) indented code/designation pairs B) indented code/designation/description triples.

Version:
1.0
Author:
solbrigcvs

Method Summary
 void load(java.net.URI source, java.lang.Character delimiter, boolean readDoublesAsTriples, boolean stopOnErrors, boolean async)
          Load content from a candidate resource.
 void validate(java.net.URI source, java.lang.Character delimiter, boolean readDoublesAsTriples, 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, getStatus, 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,
          java.lang.Character delimiter,
          boolean readDoublesAsTriples,
          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 text file.
delimiter - Optional - defaults to tab the character used to delimit pair or triple components and the nesting.
readDoublesAsTriples - Force the converter to read a doubles file (name/description) as a triples file (code/name/description) So it reads codes and names instead of names and descriptions.
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

validate

void validate(java.net.URI source,
              java.lang.Character delimiter,
              boolean readDoublesAsTriples,
              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 text file.
delimiter - Optional - defaults to tab the character used to delimit pair or triple components and the nesting.
readDoublesAsTriples - Force the converter to read a doubles file (name/description) as a triples file (code/name/description) So it reads codes and names intead of names and descriptions
validationLevel - Supported levels of validation include: 0 = Verify file syntax against the indicated format.
Throws:
LBException
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.