org.LexGrid.LexBIG.Impl.exporters
Class OBOExport
java.lang.Object
org.LexGrid.LexBIG.Impl.exporters.BaseExporter
org.LexGrid.LexBIG.Impl.exporters.OBOExport
- All Implemented Interfaces:
- java.io.Serializable, Exporter, OBO_Exporter, Extendable, StatusReporter
public class OBOExport
- extends BaseExporter
- implements OBO_Exporter
Exporter for OBO files.
- Version:
- subversion $Revision: $ checked in on $Date: $
- Author:
- Dan Armbrust
- See Also:
- Serialized Form
Field Summary |
static java.lang.String |
name
|
Methods inherited from class org.LexGrid.LexBIG.Impl.exporters.BaseExporter |
baseExport, clearLog, export, exportPickListDefinition, exportValueSetDefinition, exportValueSetResolution, getDescription, getLog, getLogger, getMessageDirector, getName, getOptions, getPickListId, getProvider, getReferences, getResourceUri, getSource, getStatus, getValueSetDefinitionRevisionId, getValueSetDefinitionURI, getVersion, isExportValueSetResolution, setExportValueSetResolution, setPickListId, setResourceUri, setSource, setValueSetDefinitionRevisionId, setValueSetDefinitionURI |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
name
public static final java.lang.String name
- See Also:
- Constant Field Values
OBOExport
public OBOExport()
register
public static void register()
throws LBParameterException,
LBException
- Throws:
LBParameterException
LBException
export
public void export(AbsoluteCodingSchemeVersionReference source,
java.net.URI destination,
boolean overwrite,
boolean stopOnErrors,
boolean async)
throws LBException
- Description copied from interface:
OBO_Exporter
- Export content from the underlying LexGrid repository.
An exception is raised if resources cannot be accessed or another load
operation is already in progress.
- Specified by:
export
in interface OBO_Exporter
- Parameters:
source
- The absolute version identifier of the coding scheme to export.destination
- URI corresponding to the OBO file to write.overwrite
- True indicates to overwrite an existing file if present. False
indicates to stop if the destination file already exists.stopOnErrors
- True means stop if any export error is detected. False means
attempt to continue writing what can be exported if
recoverable errors are encountered.async
- Flag controlling whether export occurs in the calling thread.
If true, the export will occur in a separate asynchronous
process. If false, this method blocks until the export
operation completes or fails. Regardless of setting, the
getStatus and getLog calls are used to fetch results.
- Throws:
LBException
getOBOVersion
public java.lang.String getOBOVersion()
- Description copied from interface:
OBO_Exporter
- Return the OBO text file version that is supported by the loader. (e.g.
1.0, 1.2, etc.).
- Specified by:
getOBOVersion
in interface OBO_Exporter
declareAllowedOptions
protected OptionHolder declareAllowedOptions(OptionHolder holder)
- Specified by:
declareAllowedOptions
in class BaseExporter
doExport
protected void doExport()
throws java.lang.Exception
- Specified by:
doExport
in class BaseExporter
- Throws:
java.lang.Exception