org.LexGrid.LexBIG.Extensions.Load
Interface NCIHistoryLoader

All Superinterfaces:
Extendable, Loader, java.io.Serializable, StatusReporter
All Known Implementing Classes:
NCIHistoryLoaderImpl

public interface NCIHistoryLoader
extends Loader

A loader that takes the delimited NCI history file and applies it to a coding scheme.

Version:
1.0

Method Summary
 void load(java.net.URI source, java.net.URI versions, boolean append, boolean stopOnErrors, boolean async)
          Load history from a candidate resource.
 void validate(java.net.URI source, java.net.URI versions, int validationLevel)
          Validate history 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,
          java.net.URI versions,
          boolean append,
          boolean stopOnErrors,
          boolean async)
          throws LBException
Load history from a candidate resource. An exception is raised if resources cannot be accessed or another load operation is already in progress.

Parameters:
source - URI specifying location of the history file.
versions - URI specifying location of the file containing version identifiers for the history to be loaded.
append - True means that the provided history file will be added into the current history database (a new db will be created if none exist) False means that the current database will be replaced by the new content.
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.net.URI versions,
              int validationLevel)
              throws LBException
Validate history for a candidate resource without performing a load. Returns without exception if validation succeeds.

Parameters:
source - URI corresponding to the history file.
versions - URI specifying location of the file containing version identifiers for the history to be loaded.
validationLevel - Supported levels of validation include: 0 = Verify top 10 lines are correct format. 1 = Verify entire file.
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.