org.lexevs.cts2.admin.export
Class ValueSetExportOperationImpl

java.lang.Object
  extended by org.lexevs.cts2.LexEvsBasedService
      extended by org.lexevs.cts2.BaseService
          extended by org.lexevs.cts2.admin.export.ValueSetExportOperationImpl
All Implemented Interfaces:
ValueSetExportOperation

public class ValueSetExportOperationImpl
extends BaseService
implements ValueSetExportOperation

Implementation of CTS 2 Value Set Export Operation.

Author:
Sridhar Dwarkanath

Nested Class Summary
 
Nested classes/interfaces inherited from class org.lexevs.cts2.BaseService
BaseService.KnownTags, BaseService.SortableProperties
 
Constructor Summary
ValueSetExportOperationImpl()
           
 
Method Summary
 java.net.URI exportValueSetContents(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionVersion, java.net.URI exportDestination, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String csVersionTag, boolean overwrite, boolean failOnAllErrors)
          Exports contents of Value Set Definition as Code System in LexGrid canonical XML format.
 java.net.URI exportValueSetContents(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionVersion, java.net.URI exportDestination, java.lang.String exporterName)
          Exports contents of the Value Set Definition using the exporter specified.
 void exportValueSetDefinition(java.net.URI valueSetDefinitionURI, java.lang.String valueSetDefinitionVersion, java.lang.String xmlFullPathName, boolean overwrite, boolean failOnAllErrors)
          Export Value Set Definition to LexGrid canonical XML format.
 java.util.List<java.lang.String> getSupportedExporterNames()
          Returns list of Exporter names supported by this LexEVS instance.
 
Methods inherited from class org.lexevs.cts2.BaseService
createUniqueId, getLexEvsCTS2, getServiceInfo
 
Methods inherited from class org.lexevs.cts2.LexEvsBasedService
getDatabaseServiceManager, getIndexServiceManager, getLexBIGService, getLexBIGServiceManager, getLexBIGServiceManagerCredentials, getSystemResourceService
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValueSetExportOperationImpl

public ValueSetExportOperationImpl()
Method Detail

exportValueSetDefinition

public void exportValueSetDefinition(java.net.URI valueSetDefinitionURI,
                                     java.lang.String valueSetDefinitionVersion,
                                     java.lang.String xmlFullPathName,
                                     boolean overwrite,
                                     boolean failOnAllErrors)
                              throws LBException
Description copied from interface: ValueSetExportOperation
Export Value Set Definition to LexGrid canonical XML format.

Specified by:
exportValueSetDefinition in interface ValueSetExportOperation
Parameters:
valueSetDefinitionURI - value set definition URI
valueSetDefinitionVersion - value set definition version
xmlFullPathName - File location (including file name *.xml) to save the definition
overwrite - True: to override the existing file.
failOnAllErrors - True: stops exporting if any error.
Throws:
LBException

exportValueSetContents

public java.net.URI exportValueSetContents(java.net.URI valueSetDefinitionURI,
                                           java.lang.String valueSetDefinitionVersion,
                                           java.net.URI exportDestination,
                                           java.lang.String exporterName)
                                    throws LBException
Description copied from interface: ValueSetExportOperation
Exports contents of the Value Set Definition using the exporter specified.

Specified by:
exportValueSetContents in interface ValueSetExportOperation
Parameters:
valueSetDefinitionURI - URI of the Value Set Definition to be exported
valueSetDefinitionVersion - version of the Value Set Definition to be exported
exportDestination - Destination path information for the exported file.
exporterName - Name of the exporter to use. Use getSupportedExporterNames to get all the exporters supported by this instance of CTS2.
Returns:
URI of destination if successfully exported.
Throws:
LBException

exportValueSetContents

public java.net.URI exportValueSetContents(java.net.URI valueSetDefinitionURI,
                                           java.lang.String valueSetDefinitionVersion,
                                           java.net.URI exportDestination,
                                           AbsoluteCodingSchemeVersionReferenceList csVersionList,
                                           java.lang.String csVersionTag,
                                           boolean overwrite,
                                           boolean failOnAllErrors)
                                    throws LBException
Description copied from interface: ValueSetExportOperation
Exports contents of Value Set Definition as Code System in LexGrid canonical XML format.

Specified by:
exportValueSetContents in interface ValueSetExportOperation
Parameters:
valueSetDefinitionURI - value set definition URI
valueSetDefinitionVersion - value set definition version
exportDestination - Location (path to the folder withOUT the file name) to save the definition
csVersionList - A list of coding scheme URI's and versions to be used. These will be used only if they are present in the service. If absent, the most recent version will be used instead.
csVersionTag - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
overwrite - True: to override the existing file.
failOnAllErrors - True: stops exporting if any error.
Returns:
URI of destination if successfully exported.
Throws:
LBException

getSupportedExporterNames

public java.util.List<java.lang.String> getSupportedExporterNames()
                                                           throws LBException
Description copied from interface: ValueSetExportOperation
Returns list of Exporter names supported by this LexEVS instance.

Specified by:
getSupportedExporterNames in interface ValueSetExportOperation
Returns:
List of supported Exporter names
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.