|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.LexGrid.LexBIG.Impl.Extensions.AbstractExtendable
org.LexGrid.LexBIG.Impl.loaders.NCIHistoryLoaderImpl
public class NCIHistoryLoaderImpl
Loads a NCI Thesaurus History file.
Field Summary | |
---|---|
static java.lang.String |
ASYNC_OPTION
|
static java.lang.String |
name
|
Constructor Summary | |
---|---|
NCIHistoryLoaderImpl()
|
Method Summary | |
---|---|
protected ExtensionDescription |
buildExtensionDescription()
Builds the extension description. |
void |
clearLog()
Clears any associated log entries. |
protected OptionHolder |
declareAllowedOptions(OptionHolder holder)
|
CodingSchemeManifest |
getCodingSchemeManifest()
Get the CodingSchemeManifest that would be used to modify the ontology content. |
java.net.URI |
getCodingSchemeManifestURI()
Get the URI of the codingSchemeManifest that would be used to modify the ontology content. |
AbsoluteCodingSchemeVersionReference[] |
getCodingSchemeReferences()
Returns absolute references for coding schemes loaded or used by the most recent operation; empty if not applicable. |
LoaderPreferences |
getLoaderPreferences()
Returns the current LoaderPreferences object. |
LogEntry[] |
getLog(LogLevel level)
Returns log entries for the current or most recent load operation that match a particular status; null if no operation has been attempted. |
protected LgLoggerIF |
getLogger()
|
OntologyFormat |
getOntologyFormat()
Return the ontology format the loader can handle |
OptionHolder |
getOptions()
|
java.net.URI |
getResourceUri()
|
LoadStatus |
getStatus()
Returns status of the current or most recent load or validate operation; null if no operation has been attempted. |
void |
load(java.net.URI resource)
|
void |
load(java.net.URI source,
java.net.URI versions,
boolean append,
boolean stopOnErrors,
boolean async)
Load history from a candidate resource. |
static void |
main(java.lang.String[] args)
|
static void |
register()
|
void |
setCodingSchemeManifest(CodingSchemeManifest codingSchemeManifest)
Set the CodingSchemeManifest that would be used to modify the ontology content. |
void |
setCodingSchemeManifestURI(java.net.URI codingSchemeManifestUri)
Set the URI of the codingSchemeManifest that would be used to modify the ontology content. |
void |
setLoaderPreferences(LoaderPreferences loaderPreferences)
Sets the Loader's LoaderPreferences. |
void |
setLoaderPreferences(java.net.URI loaderPreferencesURI)
Sets the Loader's LoaderPreferences URI. |
void |
setOptions(OptionHolder options)
|
void |
setResourceUri(java.net.URI resourceUri)
|
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 class org.LexGrid.LexBIG.Impl.Extensions.AbstractExtendable |
---|
getDescription, getExtensionDescription, getName, getProvider, getVersion |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable |
---|
getDescription, getName, getProvider, getVersion |
Field Detail |
---|
public static final java.lang.String name
public static java.lang.String ASYNC_OPTION
Constructor Detail |
---|
public NCIHistoryLoaderImpl()
Method Detail |
---|
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
protected LgLoggerIF getLogger()
protected ExtensionDescription buildExtensionDescription()
AbstractExtendable
buildExtensionDescription
in class AbstractExtendable
public void load(java.net.URI source, java.net.URI versions, boolean append, boolean stopOnErrors, boolean async) throws LBException
NCIHistoryLoader
load
in interface NCIHistoryLoader
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.
LBException
public void validate(java.net.URI source, java.net.URI versions, int validationLevel) throws LBException
NCIHistoryLoader
validate
in interface NCIHistoryLoader
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.
LBException
protected OptionHolder declareAllowedOptions(OptionHolder holder)
public void load(java.net.URI resource)
load
in interface Loader
public void setOptions(OptionHolder options)
public OptionHolder getOptions()
getOptions
in interface Loader
public void setResourceUri(java.net.URI resourceUri)
public java.net.URI getResourceUri()
public void clearLog()
Loader
clearLog
in interface Loader
public CodingSchemeManifest getCodingSchemeManifest()
Loader
getCodingSchemeManifest
in interface Loader
public java.net.URI getCodingSchemeManifestURI()
Loader
getCodingSchemeManifestURI
in interface Loader
public AbsoluteCodingSchemeVersionReference[] getCodingSchemeReferences()
Loader
getCodingSchemeReferences
in interface Loader
public LoaderPreferences getLoaderPreferences()
Loader
getLoaderPreferences
in interface Loader
public LogEntry[] getLog(LogLevel level)
Loader
getLog
in interface Loader
getLog
in interface StatusReporter
public LoadStatus getStatus()
Loader
getStatus
in interface Loader
getStatus
in interface StatusReporter
public void setCodingSchemeManifest(CodingSchemeManifest codingSchemeManifest)
Loader
setCodingSchemeManifest
in interface Loader
public void setCodingSchemeManifestURI(java.net.URI codingSchemeManifestUri) throws LBException
Loader
setCodingSchemeManifestURI
in interface Loader
LBException
public void setLoaderPreferences(LoaderPreferences loaderPreferences) throws LBParameterException
Loader
setLoaderPreferences
in interface Loader
loaderPreferences
- The LoaderPreference object to be loaded. It is recommended that all implementing
classes check if the LoaderPreferences object is valid for the loader.
LBParameterException
public void setLoaderPreferences(java.net.URI loaderPreferencesURI) throws LBParameterException
Loader
setLoaderPreferences
in interface Loader
LBParameterException
public static void register()
public OntologyFormat getOntologyFormat()
Loader
getOntologyFormat
in interface Loader
|
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |