org.LexGrid.LexBIG.Extensions.Load
Interface MrMap_Loader
- All Superinterfaces:
- Extendable, Loader, java.io.Serializable, StatusReporter
- All Known Implementing Classes:
- MrmapRRFLoader
public interface MrMap_Loader
- extends Loader
Loader class for MrMap and MrSat RRF files resulting in a
mapping coding scheme or schemes depending on the content of these files.
- Author:
- Scott Bauer
Field Summary |
static java.lang.String |
description
|
static java.lang.String |
name
|
Method Summary |
void |
load(java.net.URI mrMapsource,
java.net.URI mrSatSource,
java.lang.String nameForMappingScheme,
java.lang.String nameForMappingVersion,
java.lang.String nameforMappingURI,
java.lang.String sourceScheme,
java.lang.String sourceVersion,
java.lang.String sourceURI,
java.lang.String targetScheme,
java.lang.String targetVersion,
java.lang.String targetURI,
boolean stopOnErrors,
boolean async)
User designated target Scheme URI. |
void |
validate(java.lang.String 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 |
name
static final java.lang.String name
- See Also:
- Constant Field Values
description
static final java.lang.String description
- See Also:
- Constant Field Values
load
void load(java.net.URI mrMapsource,
java.net.URI mrSatSource,
java.lang.String nameForMappingScheme,
java.lang.String nameForMappingVersion,
java.lang.String nameforMappingURI,
java.lang.String sourceScheme,
java.lang.String sourceVersion,
java.lang.String sourceURI,
java.lang.String targetScheme,
java.lang.String targetVersion,
java.lang.String targetURI,
boolean stopOnErrors,
boolean async)
throws LBException
- User designated target Scheme URI. Non-resolving default used if null.
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:
mrMapsource
- String representation of the path to corresponding to the RRF
file.mrSatSource
- String representation of the path to corresponding to the RRF
file.nameForMappingScheme
- User designated Mapping Scheme identifier. Default used if
null.nameForMappingVersion
- User designated Mapping Scheme Version. Default used if null.nameforMappingURI
- User designated Mapping Scheme URI. Non-resolving default used
if null.sourceScheme
- User designated source scheme identifier which can a local
scheme to to which mappings resolve. Non resolving default
created if null.sourceVersion
- User designated source scheme Version. Default used if null.
Dependent on valid user defined source scheme identifiersourceURI
- User designated source scheme URI. Non-resolving default used
if null.targetScheme
- User designated target scheme identifier which can a local
scheme to to which mappings resolve. Non resolving default
created if null. Dependent on valid user defined source scheme
identifier.targetVersion
- User designated target scheme Version. Default used if null.targetURI
- source
- String representation of the path to corresponding to the RRF
file.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.lang.String 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 XML file.validationLevel
- Supported levels of validation include: 0 = Verify XML is well
formed. 1 = Verify XML is valid.
- Throws:
LBException