org.LexGrid.LexBIG.Extensions.Export
Interface LexGrid_Exporter

All Superinterfaces:
Exporter, Extendable, java.io.Serializable, StatusReporter
All Known Implementing Classes:
LexGridExport

public interface LexGrid_Exporter
extends Exporter

Exports content to LexGrid cononical XML format.


Method Summary
 void export(AbsoluteCodingSchemeVersionReference source, java.net.URI destination, boolean overwrite, boolean stopOnErrors, boolean async)
          Export content from the underlying LexGrid repository.
 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.
 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.
 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.
 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.
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Export.Exporter
clearLog, export, exportPickListDefinition, exportValueSetDefinition, getLog, getOptions, getReferences, getStatus
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable
getDescription, getName, getProvider, getVersion
 

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, ...).


export

void export(AbsoluteCodingSchemeVersionReference source,
            java.net.URI destination,
            boolean overwrite,
            boolean stopOnErrors,
            boolean async)
            throws LBException
Export content from the underlying LexGrid repository. An exception is raised if resources cannot be accessed or another load operation is already in progress.

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

exportValueSetDefinition

void exportValueSetDefinition(java.net.URI valueSetDefinitionURI,
                              java.lang.String valueSetDefinitionRevisionId,
                              java.net.URI destination,
                              boolean overwrite,
                              boolean stopOnErros,
                              boolean async)
                              throws LBException
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.

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.
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

exportValueSetResolution

void exportValueSetResolution(java.net.URI valueSetDefinitionURI,
                              java.lang.String valueSetDefinitionRevisionId,
                              java.net.URI destination,
                              boolean overwrite,
                              boolean stopOnErros,
                              boolean async)
                              throws LBException
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.

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.
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

void exportPickListDefinition(java.lang.String pickListId,
                              java.net.URI destination,
                              boolean overwrite,
                              boolean stopOnErros,
                              boolean async)
                              throws LBException
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.

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.
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

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.