org.LexGrid.LexBIG.Impl.loaders
Class RadLexProtegeFramesLoaderImpl

java.lang.Object
  extended by org.LexGrid.LexBIG.Impl.Extensions.AbstractExtendable
      extended by org.LexGrid.LexBIG.Impl.loaders.BaseLoader
          extended by org.LexGrid.LexBIG.Impl.loaders.RadLexProtegeFramesLoaderImpl
All Implemented Interfaces:
java.io.Serializable, Extendable, Loader, RadlexProtegeFrames_Loader, StatusReporter

public class RadLexProtegeFramesLoaderImpl
extends BaseLoader
implements RadlexProtegeFrames_Loader

Validates and/or loads RadLex content, provided by the Radiological Society of North America in Protégé frame format.

Version:
subversion $Revision: $ checked in on $Date: $
Author:
Dan Armbrust
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.LexGrid.LexBIG.Impl.loaders.BaseLoader
BaseLoader.DoConversion
 
Field Summary
static java.lang.String name
           
 
Fields inherited from class org.LexGrid.LexBIG.Impl.loaders.BaseLoader
ASYNC_OPTION, FAIL_ON_ERROR_OPTION, inUse, LOADER_POST_PROCESSOR_OPTION, LOADER_PREFERENCE_FILE_OPTION, MANIFEST_FILE_OPTION, SUPPLEMENT_OPTION
 
Constructor Summary
RadLexProtegeFramesLoaderImpl()
           
 
Method Summary
protected  ExtensionDescription buildExtensionDescription()
          Builds the extension description.
protected  OptionHolder declareAllowedOptions(OptionHolder holder)
           
protected  URNVersionPair[] doLoad()
           
 void finalize()
           
 OntologyFormat getOntologyFormat()
          Return the ontology format the loader can handle
 void load(java.net.URI uri, boolean stopOnErrors, boolean async)
          Load the Radiological Lexicon (RadLex) ontology from a Protégé Frames (.pprj) file format.
 void validate(java.net.URI uri, int validationLevel)
          Validate content for a candidate resource without performing a load.
 
Methods inherited from class org.LexGrid.LexBIG.Impl.loaders.BaseLoader
addBooleanOptionValue, baseLoad, buildRootNode, clearLog, constructVersionPairsFromCodingSchemes, createCachingMessageDirectorIF, createDefaultInserter, createDefaultInserter, doesOptionExist, doIndex, doPostProcessing, doTransitiveAndIndex, doTransitiveTable, getAbsoluteCodingSchemeVersionReferenceFromOptionString, getCodingSchemeManifest, getCodingSchemeManifestURI, getCodingSchemeReferences, getDescription, getLoaderPreferences, getLog, getLogger, getManifestUtil, getMessageDirector, getName, getOptions, getPostProcessor, getProvider, getResourceUri, getStatus, getStringFromURI, getVersion, isDoApplyPostLoadManifest, isDoComputeTransitiveClosure, isDoIndexing, isDoRegister, isDoRemoveOnFailure, isInUse, load, lock, persistCodingSchemeToDatabase, persistCodingSchemeToDatabase, register, register, setCachingMessageDirectorIF, setCodingSchemeManifest, setCodingSchemeManifestURI, setCodingSchemeReferences, setDoApplyPostLoadManifest, setDoComputeTransitiveClosure, setDoIndexing, setDoRegister, setDoRemoveOnFailure, setInUse, setLoaderPreferences, setLoaderPreferences, setManifestUtil, setOptions, setResourceUri, setStatus, unlock, urnVersionPairToAbsoluteCodingSchemeVersionReference
 
Methods inherited from class org.LexGrid.LexBIG.Impl.Extensions.AbstractExtendable
getExtensionDescription
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Load.Loader
clearLog, getCodingSchemeManifest, getCodingSchemeManifestURI, getCodingSchemeReferences, getLoaderPreferences, getLog, getOptions, getStatus, load, setCodingSchemeManifest, setCodingSchemeManifestURI, setLoaderPreferences, setLoaderPreferences
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable
getDescription, getName, getProvider, getVersion
 

Field Detail

name

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

RadLexProtegeFramesLoaderImpl

public RadLexProtegeFramesLoaderImpl()
Method Detail

validate

public void validate(java.net.URI uri,
                     int validationLevel)
              throws LBParameterException
Description copied from interface: RadlexProtegeFrames_Loader
Validate content for a candidate resource without performing a load. Returns without exception if validation succeeds.

Specified by:
validate in interface RadlexProtegeFrames_Loader
Parameters:
uri - URI corresponding to the Protégé project (typically .pprj) file.
validationLevel - Supported levels of validation include: 0 = Verify the source file exists.
Throws:
LBParameterException

load

public void load(java.net.URI uri,
                 boolean stopOnErrors,
                 boolean async)
          throws LBParameterException,
                 LBInvocationException
Description copied from interface: RadlexProtegeFrames_Loader
Load the Radiological Lexicon (RadLex) ontology from a Protégé Frames (.pprj) file format. 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.

Specified by:
load in interface RadlexProtegeFrames_Loader
Parameters:
uri - URI corresponding to the Protégé project (typically .pprj) 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:
LBParameterException
LBInvocationException

finalize

public void finalize()
              throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable

declareAllowedOptions

protected OptionHolder declareAllowedOptions(OptionHolder holder)
Specified by:
declareAllowedOptions in class BaseLoader

doLoad

protected URNVersionPair[] doLoad()
                           throws CodingSchemeAlreadyLoadedException
Specified by:
doLoad in class BaseLoader
Throws:
CodingSchemeAlreadyLoadedException

buildExtensionDescription

protected ExtensionDescription buildExtensionDescription()
Description copied from class: AbstractExtendable
Builds the extension description.

Specified by:
buildExtensionDescription in class AbstractExtendable
Returns:
the extension description

getOntologyFormat

public OntologyFormat getOntologyFormat()
Description copied from interface: Loader
Return the ontology format the loader can handle

Specified by:
getOntologyFormat in interface Loader
Overrides:
getOntologyFormat in class BaseLoader

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.