org.LexGrid.LexBIG.Extensions.Load
Interface LexGrid_Loader

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

public interface LexGrid_Loader
extends Loader

Validates and/or loads content provided in LexGrid cononical XML format.

Version:
1.0
Author:
solbrigcvs

Field Summary
static java.lang.String description
           
static java.lang.String name
           
 
Method Summary
 java.net.URI getSchemaURL()
          Return a reference to the XML Schema that this loader supports.
 java.lang.String getSchemaVersion()
          Return the version identifier of the schema that this loader supports.
 void load(java.net.URI source, boolean stopOnErrors, boolean async)
          Load content from a candidate resource.
 void validate(java.net.URI 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
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable
getDescription, getName, getProvider, getVersion
 

Field Detail

name

static final java.lang.String name
See Also:
Constant Field Values

description

static final java.lang.String description
See Also:
Constant Field Values
Method Detail

getSchemaURL

java.net.URI getSchemaURL()
Return a reference to the XML Schema that this loader supports.


getSchemaVersion

java.lang.String getSchemaVersion()
Return the version identifier of the schema that this loader supports. (e.g. 2004/02, 2005/01, ...).


load

void load(java.net.URI source,
          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 XML 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.net.URI 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

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.