org.lexevs.cts2.admin.export
Interface CodeSystemExportOperation

All Known Implementing Classes:
CodeSystemExportOperationImpl

public interface CodeSystemExportOperation

LexEVS CTS 2 Code System Export Operation.

Author:
Sridhar Dwarkanath

Method Summary
 java.net.URI exportCodedNodeGraph(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, CodedNodeGraph cng, java.net.URI exportDestination, boolean overwrite, boolean stopOnErrors, boolean async)
          Resolves the given CodedNodeGraph(CNG) and exports the contents.
 java.net.URI exportCodedNodeSet(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, CodedNodeSet cns, java.net.URI exportDestination, boolean overwrite, boolean stopOnErrors, boolean async)
          Resolves the given CodedNodeSet(CNS) and exports the contents.
 java.net.URI exportCodeSystemContent(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, java.net.URI exportDestination, Exporter exporter)
          Exports contents of the code system using the exporter specified.
 CodedNodeGraph getCodeSystemCodedNodeGraph(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Returns CodedNodeGraph(CNG) for a Code System Version.
 CodedNodeSet getCodeSystemCodedNodeSet(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Returns CodedNodeSet(CNS) for a Code System Version.
 java.util.List<java.lang.String> getSupportedExporterNames()
          Returns list of Exporter names supported by this LexEVS instance.
 

Method Detail

exportCodeSystemContent

java.net.URI exportCodeSystemContent(java.lang.String codeSystemNameOrURI,
                                     java.lang.String codeSystemVersion,
                                     java.net.URI exportDestination,
                                     Exporter exporter)
                                     throws LBException
Exports contents of the code system using the exporter specified.

Parameters:
codeSystemNameOrURI - URI of the Code System to be exported
codeSystemVersion - Version of the Code System to be exported
exportDestination - Destination path information for the exported file.
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

getCodeSystemCodedNodeSet

CodedNodeSet getCodeSystemCodedNodeSet(java.lang.String codeSystemNameOrURI,
                                       java.lang.String codeSystemVersion)
                                       throws LBException
Returns CodedNodeSet(CNS) for a Code System Version. This CNS can be used to apply further restrictions before exporting.

Parameters:
codeSystemNameOrURI - URI of the Code System to be exported
codeSystemVersion - Version of the Code System to be exported
Returns:
CodedNodeSet of the Code System Version
Throws:
LBException

getCodeSystemCodedNodeGraph

CodedNodeGraph getCodeSystemCodedNodeGraph(java.lang.String codeSystemNameOrURI,
                                           java.lang.String codeSystemVersion)
                                           throws LBException
Returns CodedNodeGraph(CNG) for a Code System Version. This CNG can be used to apply further restrictions before exporting.

Parameters:
codeSystemNameOrURI - URI of the Code System to be exported
codeSystemVersion - Version of the Code System to be exported
Returns:
CodedNodeGraph of the Code System Version
Throws:
LBException

exportCodedNodeSet

java.net.URI exportCodedNodeSet(java.lang.String codeSystemNameOrURI,
                                java.lang.String codeSystemVersion,
                                CodedNodeSet cns,
                                java.net.URI exportDestination,
                                boolean overwrite,
                                boolean stopOnErrors,
                                boolean async)
                                throws LBException
Resolves the given CodedNodeSet(CNS) and exports the contents.

Parameters:
codeSystemNameOrURI - URI of the Code System to be used for resolving the CNS
codeSystemVersion - Version of the Code System to be used for resolving the CNS
cns - Coded Node Set
exportDestination - Destination for the exported file
overwrite - True means, any existing file will be overwritten
stopOnErrors - True means stop if any export error is detected. False means attempt to export 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.
Returns:
URI of destination if successfully exported.
Throws:
LBException

exportCodedNodeGraph

java.net.URI exportCodedNodeGraph(java.lang.String codeSystemNameOrURI,
                                  java.lang.String codeSystemVersion,
                                  CodedNodeGraph cng,
                                  java.net.URI exportDestination,
                                  boolean overwrite,
                                  boolean stopOnErrors,
                                  boolean async)
                                  throws LBException
Resolves the given CodedNodeGraph(CNG) and exports the contents.

Parameters:
codeSystemNameOrURI - URI of the Code System to be used for resolving the CNG
codeSystemVersion - Version of the Code System to be used for resolving the CNG
cng - Coded Node Graph
exportDestination - Destination for the exported file
overwrite - True means, any existing file will be overwritten
stopOnErrors - True means stop if any export error is detected. False means attempt to export 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.
Returns:
URI of destination if successfully exported.
Throws:
LBException

getSupportedExporterNames

java.util.List<java.lang.String> getSupportedExporterNames()
                                                           throws LBException
Returns list of Exporter names supported by this LexEVS instance.

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.