org.LexGrid.LexBIG.Impl.exporters
Class LexGridExport

java.lang.Object
  extended by org.LexGrid.LexBIG.Impl.exporters.BaseExporter
      extended by org.LexGrid.LexBIG.Impl.exporters.LexGridExport
All Implemented Interfaces:
java.io.Serializable, Exporter, LexGrid_Exporter, Extendable, StatusReporter

public class LexGridExport
extends BaseExporter
implements LexGrid_Exporter

Exporter for LexGrid XML files.

Version:
subversion $Revision: $ checked in on $Date: $
Author:
Deepak Sharma, Michael Turk
See Also:
Serialized Form

Field Summary
static java.lang.String name
           
 
Fields inherited from class org.LexGrid.LexBIG.Impl.exporters.BaseExporter
ASYNC_OPTION, description_, FAIL_ON_ERROR_OPTION, name_, OVERWRITE_OPTION, provider_, version_
 
Constructor Summary
LexGridExport()
           
 
Method Summary
protected  OptionHolder declareAllowedOptions(OptionHolder holder)
           
protected  void doExport()
           
 void export(AbsoluteCodingSchemeVersionReference source, java.net.URI destination, boolean overwrite, boolean stopOnErrors, boolean async)
          Export content from the underlying LexGrid repository.
protected  void exportCodingSchemeData()
           
 void exportPickListDefinition(java.lang.String pickListId, java.net.URI destination, boolean overwrite, boolean stopOnErros, boolean async)
          Export content of PickList Definition from the underlying LexGrid repository.
protected  void exportPickListDefinitionData()
           
 void exportValueSetDefinition(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId, java.net.URI destination, boolean overwrite, boolean stopOnErros, boolean async)
          Export Value Set Definition from the underlying LexGrid repository.
protected  void exportValueSetDefinitionData()
           
 void exportValueSetResolution(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionRevisionId, java.net.URI destination, boolean overwrite, boolean stopOnErros, boolean async)
          Exports expanded contents of Value Set Definition from the underlying LexGrid repository.
protected  void exportValueSetResolutionData()
           
 OptionHolder getOptions()
           
 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.
static void register()
           
 void setCng(CodedNodeGraph cng)
           
 void setCns(CodedNodeSet cns)
           
 
Methods inherited from class org.LexGrid.LexBIG.Impl.exporters.BaseExporter
baseExport, clearLog, export, exportPickListDefinition, exportValueSetDefinition, exportValueSetResolution, getDescription, getLog, getLogger, getMessageDirector, getName, 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
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Export.Exporter
clearLog, export, exportPickListDefinition, exportValueSetDefinition, getLog, getReferences, getStatus
 
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

LexGridExport

public LexGridExport()
Method Detail

setCns

public void setCns(CodedNodeSet cns)

setCng

public void setCng(CodedNodeGraph cng)

register

public static void register()
                     throws LBParameterException,
                            LBException
Throws:
LBParameterException
LBException

doExport

protected void doExport()
Specified by:
doExport in class BaseExporter

exportCodingSchemeData

protected void exportCodingSchemeData()

exportValueSetResolutionData

protected void exportValueSetResolutionData()

exportValueSetDefinitionData

protected void exportValueSetDefinitionData()

exportPickListDefinitionData

protected void exportPickListDefinitionData()

getSchemaURL

public java.net.URI getSchemaURL()
Description copied from interface: LexGrid_Exporter
Return a reference to the XML Schema that this loader supports.

Specified by:
getSchemaURL in interface LexGrid_Exporter

getSchemaVersion

public java.lang.String getSchemaVersion()
Description copied from interface: LexGrid_Exporter
Return the version identifier of the schema that this loader supports. (e.g. 2004/02, 2005/01, ...).

Specified by:
getSchemaVersion in interface LexGrid_Exporter

declareAllowedOptions

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

getOptions

public OptionHolder getOptions()
Specified by:
getOptions in interface Exporter
Overrides:
getOptions in class BaseExporter

export

public void export(AbsoluteCodingSchemeVersionReference source,
                   java.net.URI destination,
                   boolean overwrite,
                   boolean stopOnErrors,
                   boolean async)
            throws LBException
Description copied from interface: LexGrid_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 LexGrid_Exporter
Parameters:
source - The absolute version identifier of the coding scheme to export.
destination - URI corresponding to the XML 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

exportPickListDefinition

public void exportPickListDefinition(java.lang.String pickListId,
                                     java.net.URI destination,
                                     boolean overwrite,
                                     boolean stopOnErros,
                                     boolean async)
                              throws LBException
Description copied from interface: LexGrid_Exporter
Export content of PickList Definition from the underlying LexGrid repository. An exception is raised if resources cannot be accessed or another load operation is already in progress.

Specified by:
exportPickListDefinition in interface LexGrid_Exporter
Parameters:
pickListId - ID of the pick list definition to export.
destination - URI corresponding to the XML file to write.
overwrite - True indicates to overwrite an existing file if present. False indicates to stop if the destination file already exists.
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

exportValueSetDefinition

public void exportValueSetDefinition(java.net.URI valueSetDefinitionURI,
                                     java.lang.String valueSetDefinitionRevisionId,
                                     java.net.URI destination,
                                     boolean overwrite,
                                     boolean stopOnErros,
                                     boolean async)
                              throws LBException
Description copied from interface: LexGrid_Exporter
Export Value Set Definition from the underlying LexGrid repository. An exception is raised if resources cannot be accessed or another load operation is already in progress.

Specified by:
exportValueSetDefinition in interface LexGrid_Exporter
Parameters:
valueSetDefinitionURI - URI of the value set definition to export.
valueSetDefinitionRevisionId - RevisionId of the value set definition to export.
destination - URI corresponding to the XML file to write.
overwrite - True indicates to overwrite an existing file if present. False indicates to stop if the destination file already exists.
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

exportValueSetResolution

public void exportValueSetResolution(java.net.URI valueSetDefinitionURI,
                                     java.lang.String valueSetDefinitionRevisionId,
                                     java.net.URI destination,
                                     boolean overwrite,
                                     boolean stopOnErros,
                                     boolean async)
                              throws LBException
Description copied from interface: LexGrid_Exporter
Exports expanded contents of Value Set Definition from the underlying LexGrid repository. An exception is raised if resources cannot be accessed or another load operation is already in progress.

Specified by:
exportValueSetResolution in interface LexGrid_Exporter
Parameters:
valueSetDefinitionURI - URI of the value set definition to export.
valueSetDefinitionRevisionId - RevisionId of the value set definition to export.
destination - URI corresponding to the XML file to write.
overwrite - True indicates to overwrite an existing file if present. False indicates to stop if the destination file already exists.
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

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.