org.LexGrid.LexBIG.Extensions.Load
Interface Loader

All Superinterfaces:
Extendable, java.io.Serializable
All Known Subinterfaces:
HL7_Loader, IndexLoader, LexGrid_Loader, MetaData_Loader, NCI_MetaThesaurusLoader, NCIHistoryLoader, OBO_Loader, OBOHistoryLoader, OWL_Loader, RadlexProtegeFrames_Loader, Text_Loader, UMLS_Loader, UMLSHistoryLoader

public interface Loader
extends Extendable

The loader interface validates and/or loads content for a service.

Version:
1.0
Author:
solbrigcvs

Method Summary
 void clearLog()
          Clears any associated log entries.
 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.
 LoadStatus getStatus()
          Returns status of the current or most recent load or validate operation; null if no operation has been attempted.
 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.
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable
getDescription, getName, getProvider, getVersion
 

Method Detail

clearLog

void clearLog()
Clears any associated log entries.


getCodingSchemeReferences

AbsoluteCodingSchemeVersionReference[] getCodingSchemeReferences()
Returns absolute references for coding schemes loaded or used by the most recent operation; empty if not applicable.


getLog

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.

Parameters:
status - One of several log levels defined by the system, or null to return all log entries.

getStatus

LoadStatus getStatus()
Returns status of the current or most recent load or validate operation; null if no operation has been attempted.


setCodingSchemeManifest

void setCodingSchemeManifest(CodingSchemeManifest codingSchemeManifest)
Set the CodingSchemeManifest that would be used to modify the ontology content. Once the ontology is loaded from the source, the manifest would then be applied to modify the loaded content.

Parameters:
csm -

getCodingSchemeManifest

CodingSchemeManifest getCodingSchemeManifest()
Get the CodingSchemeManifest that would be used to modify the ontology content. Once the ontology is loaded from the source, the manifest would then be applied to modify the loaded content.

Parameters:
csm -

setCodingSchemeManifestURI

void setCodingSchemeManifestURI(java.net.URI codingSchemeManifestUri)
                                throws LBException
Set the URI of the codingSchemeManifest that would be used to modify the ontology content. The CodingSchemeManifest object referenced by the URI is used to set the codingSchemeManifest as well. Once the ontology is loaded from the source, the manifest would then be applied to modify the loaded content.

Parameters:
csm -
Throws:
LBException

getCodingSchemeManifestURI

java.net.URI getCodingSchemeManifestURI()
Get the URI of the codingSchemeManifest that would be used to modify the ontology content. Once the ontology is loaded from the source, the manifest would then be applied to modify the loaded content.

Parameters:
csm -

getLoaderPreferences

LoaderPreferences getLoaderPreferences()
Returns the current LoaderPreferences object.

Returns:
The current LoaderPreferences

setLoaderPreferences

void setLoaderPreferences(LoaderPreferences loaderPreferences)
                          throws LBParameterException
Sets the Loader's LoaderPreferences.

Parameters:
loaderPreferences - The LoaderPreference object to be loaded. It is recommended that all implementing classes check if the LoaderPreferences object is valid for the loader.
Throws:
LBParameterException

setLoaderPreferences

void setLoaderPreferences(java.net.URI loaderPreferencesURI)
                          throws LBParameterException
Sets the Loader's LoaderPreferences URI.

Parameters:
loaderPreferences - The LoaderPreference URI file to be loaded.
Throws:
LBParameterException

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.