org.LexGrid.LexBIG.Extensions.Load
Interface OBO_Loader
- All Superinterfaces:
- Extendable, Loader, java.io.Serializable, StatusReporter
- All Known Implementing Classes:
- OBOLoaderImpl
public interface OBO_Loader
- extends Loader
Validates and/or loads content provided in OBO text format.
- Version:
- 1.0
- Author:
- solbrigcvs
Field Summary |
static java.lang.String |
description
|
static java.lang.String |
name
Return the OBO text file version that is supported by the loader. |
Method Summary |
java.lang.String |
getOBOVersion()
|
void |
load(java.net.URI source,
java.net.URI metaSource,
boolean stopOnErrors,
boolean async)
Load content from a candidate resource. |
void |
validate(java.net.URI source,
java.net.URI metaSource,
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 |
name
static final java.lang.String name
- Return the OBO text file version that is supported by the loader. (e.g.
1.0, 1.2, etc.).
- See Also:
- Constant Field Values
description
static final java.lang.String description
- See Also:
- Constant Field Values
getOBOVersion
java.lang.String getOBOVersion()
load
void load(java.net.URI source,
java.net.URI metaSource,
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 OBO file.metaSource
- URI corresponding to the OBO metadata XML file. Optional.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 metaSource,
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 OBO file.metaSource
- URI corresponding to the OBO metadata XML file. Optional.validationLevel
- Supported levels of validation include: 0 = Verify the source file
conforms to the OBO format, and the metadata file conforms to the
OBO metadata format.
- Throws:
LBException
LBException