www.sdmetrics.com

com.sdmetrics.output
Class DataExportConfiguration

java.lang.Object
  extended by com.sdmetrics.output.DataExportConfiguration

public class DataExportConfiguration
extends java.lang.Object

Encapsulates the output configuration settings for data export.


Nested Class Summary
static class DataExportConfiguration.QuotingStrategy
          Enumerates the quoting strategies for text-based output file formats such as CSV.
 
Constructor Summary
DataExportConfiguration()
          Constructs a default configuration, Uses the VMs default character encoding, unsanitized output into a single file, overwrites files without asking.
 
Method Summary
 void setEncoding(java.lang.String encoding)
          Sets the character encoding for the output files.
 void setOverwriteConfirmer(OverwriteConfirmation overwriteConfirmer)
          Sets the object to ask if a file can be overwritten.
 void setPreferredSeparator(java.lang.String preferredSeparator)
          Sets the column separator for text-based output formats such as CSV.
 void setQuotingStrategy(DataExportConfiguration.QuotingStrategy quotingStrategy)
          Sets the quoting strategy for text-based output formats.
 void setSanitizeOutput(boolean sanitizeOutput)
          Specifies whether or not to output the row header column.
 void setSingleOutputFile(boolean singleOutputFile)
          Specifies whether or not to write all data tables to a single file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataExportConfiguration

public DataExportConfiguration()
Constructs a default configuration, Uses the VMs default character encoding, unsanitized output into a single file, overwrites files without asking.

Method Detail

setEncoding

public void setEncoding(java.lang.String encoding)
Sets the character encoding for the output files.

Parameters:
encoding - Name of an encoding that Charset.forName(String) will understand.

setSingleOutputFile

public void setSingleOutputFile(boolean singleOutputFile)
Specifies whether or not to write all data tables to a single file.

Parameters:
singleOutputFile - true for output to a single file, false to write each table to a separate file

setSanitizeOutput

public void setSanitizeOutput(boolean sanitizeOutput)
Specifies whether or not to output the row header column. The row header column usually contains model element names.

Parameters:
sanitizeOutput - true to suppress output of the row header column, false to include it in the output.

setPreferredSeparator

public void setPreferredSeparator(java.lang.String preferredSeparator)
Sets the column separator for text-based output formats such as CSV.

Parameters:
preferredSeparator - The separator string to use if the format allows alternative separators.

setQuotingStrategy

public void setQuotingStrategy(DataExportConfiguration.QuotingStrategy quotingStrategy)
Sets the quoting strategy for text-based output formats.

Values that themselves include line or column separator characters should be set in quotes to preserve the table structure.

Parameters:
quotingStrategy - The applicable quoting strategy.

setOverwriteConfirmer

public void setOverwriteConfirmer(OverwriteConfirmation overwriteConfirmer)
Sets the object to ask if a file can be overwritten.

Parameters:
overwriteConfirmer - The objects that knows or knows how to find out what files can be overwritten

www.sdmetrics.com