com.univocity.api.config.builders
Interface ExportOutput

All Known Subinterfaces:
CreateTableExportOptions

public interface ExportOutput

Executes an Export operation over a given set of data entities and submits the results to a given output.

Author:
uniVocity Software Pty Ltd - dev@univocity.com

Method Summary
 void toDirectory(File outputDir)
          Exports the result of an Export operation as multiple files in a given directory.
 void toDirectory(File outputDir, Charset encoding)
          Exports the result of an Export operation as multiple files in a given directory.
 void toDirectory(File outputDir, String encoding)
          Exports the result of an Export operation as multiple files in a given directory.
 void toDirectory(String pathToOutputDir)
          Exports the result of an Export operation as multiple files in a given directory.
 void toDirectory(String pathToOutputDir, Charset encoding)
          Exports the result of an Export operation as multiple files in a given directory.
 void toDirectory(String pathToOutputDir, String encoding)
          Exports the result of an Export operation as multiple files in a given directory.
 void toFile(File outputFile)
          Exports the result of an Export operation as a file.
 void toFile(File outputFile, Charset encoding)
          Exports the text result of an Export to a File.
 void toFile(File outputFile, String encoding)
          Exports the text result of an Export to a file.
 void toFile(String pathToOutputFile)
          Exports the result of an Export operation as a file.
 void toFile(String pathToOutputFile, Charset encoding)
          Exports the text result of an Export to a File.
 void toFile(String pathToOutputFile, String encoding)
          Exports the text result of an Export to a File.
 Map<String,Object> toMap()
          Exports the result of an Export operation as a Map.
 Object toObject()
          Exports the result of an Export operation as an object.
 

Method Detail

toObject

Object toObject()
Exports the result of an Export operation as an object.

Returns:
an object containing the result of the Export operation

toFile

void toFile(File outputFile)
Exports the result of an Export operation as a file.

If the output is text-based, the default system encoding will be used to encode the text.

Parameters:
outputFile - the file which will receive the export results.

toFile

void toFile(File outputFile,
            String encoding)
Exports the text result of an Export to a file.

Parameters:
outputFile - the file which will receive the export results.
encoding - the encoding used to encode the results.

toFile

void toFile(File outputFile,
            Charset encoding)
Exports the text result of an Export to a File.

Parameters:
outputFile - the file which will receive the export results.
encoding - the encoding used to encode the results.

toFile

void toFile(String pathToOutputFile)
Exports the result of an Export operation as a file.

If the output is text-based, the default system encoding will be used to encode the text.

Parameters:
pathToOutputFile - path to the output file which will receive the export results.

toFile

void toFile(String pathToOutputFile,
            String encoding)
Exports the text result of an Export to a File.

Parameters:
pathToOutputFile - path to the output file which will receive the export results.
encoding - the encoding used to encode the results.

toFile

void toFile(String pathToOutputFile,
            Charset encoding)
Exports the text result of an Export to a File.

Parameters:
pathToOutputFile - path to the output file which will receive the export results.
encoding - the encoding used to encode the results.

toMap

Map<String,Object> toMap()
Exports the result of an Export operation as a Map. Keys on the map contain the entity name used to perform the export.

Returns:
a Map associating the name of each exported entity with their corresponding result

toDirectory

void toDirectory(File outputDir)
Exports the result of an Export operation as multiple files in a given directory. Each file will have the name of the entity used to perform the export. File extensions depend on the export operation itself.

If the output is text-based, the default system encoding will be used to encode the text.

Parameters:
outputDir - the directory in the file system where the export result files will be created.

toDirectory

void toDirectory(File outputDir,
                 String encoding)
Exports the result of an Export operation as multiple files in a given directory. Each file will have the name of the entity used to perform the export. File extensions depend on the export operation itself.

Parameters:
outputDir - the directory in the file system where the export result files will be created.
encoding - the encoding used to encode the export result files.

toDirectory

void toDirectory(File outputDir,
                 Charset encoding)
Exports the result of an Export operation as multiple files in a given directory. Each file will have the name of the entity used to perform the export. File extensions depend on the export operation itself.

Parameters:
outputDir - the directory in the file system where the export result files will be created.
encoding - the encoding used to encode the export result files.

toDirectory

void toDirectory(String pathToOutputDir)
Exports the result of an Export operation as multiple files in a given directory. Each file will have the name of the entity used to perform the export. File extensions depend on the export operation itself.

If the output is text-based, the default system encoding will be used to encode the text.

Parameters:
pathToOutputDir - path to a directory in the file system where the export result files will be created.

toDirectory

void toDirectory(String pathToOutputDir,
                 String encoding)
Exports the result of an Export operation as multiple files in a given directory. Each file will have the name of the entity used to perform the export. File extensions depend on the export operation itself.

Parameters:
pathToOutputDir - path to a directory in the file system where the export result files will be created.
encoding - the encoding used to encode the export result files.

toDirectory

void toDirectory(String pathToOutputDir,
                 Charset encoding)
Exports the result of an Export operation as multiple files in a given directory. Each file will have the name of the entity used to perform the export. File extensions depend on the export operation itself.

Parameters:
pathToOutputDir - path to a directory in the file system where the export result files will be created.
encoding - the encoding used to encode the export result files.


Copyright © 2015 uniVocity Software Pty Ltd. All rights reserved.