Package com.orchestranetworks.addon.dex.configuration

Class CSVExportConfigurationSpec

java.lang.Object

com.orchestranetworks.addon.dex.configuration.FileExportConfigurationSpec

com.orchestranetworks.addon.dex.configuration.CSVExportConfigurationSpec

All Implemented Interfaces:

ConfigurationSpec<EBXTable>, ExportConfigurationSpec<EBXTable>

public final class CSVExportConfigurationSpec
extends FileExportConfigurationSpec

Specifies the configuration used when exporting data to a CSV file.

Since:

2.3.0

Constructor Summary

Constructors

Constructor	Description
CSVExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, TableFilter tableFilter, com.orchestranetworks.service.Session session)
CSVExportConfigurationSpec(EBXTable sourceTable, TableFilter tableFilter, com.orchestranetworks.service.Session session)
CSVExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext)

Method Summary

Modifier and Type	Method	Description
Map<Field,String>	getDateTimePatterns()	Returns a map of date time patterns and Field instance as the key parameter.
String	getDelimiter()	Returns the character used to mark the beginning and end of a cell in the CSV file.
String	getFileEncoding()	Returns the character encoding to use.
Locale	getLocaleForNumberFormat()	Returns the locale and the corresponding number format policy used in the exported file.
String	getSeparator()	Returns the separator character.
String	getSeparatorUsedForValuesList()	Returns the separator character to use for value lists.
ServiceType	getServiceType()	Returns the service type.
Map<EBXTable,TableFilter>	getSourceTableFilters()	Returns a map of table filters and EBXTable instance as the key parameter.
List<EBXTable>	getSourceTables()	Returns the list of source tables.
boolean	isDelimiterUsedForOnlyString()	Returns true if the delimiter is only used for string data types.
boolean	isEnumerationLabelExported()	Returns true if the exported file will contain an information column with the label of the enumeration.
boolean	isForeignKeyLabelExported()	Returns true if the exported file contains an information column with the foreign key label.
boolean	isLocaleForNumberFormatUsed()	Returns true if the language and corresponding number format policy are applied.
boolean	isPrimaryKeyLabelExported()	Returns true if the exported file contains an information column with the primary key label.
void	setDateTimePatterns(Map<Field,String> dateTimePatterns)	Sets a map of date time patterns and Field instance as the key parameter.
void	setDelimiter(String delimiter)	Sets the character is used to mark the beginning and end of a cell in the CSV file.
void	setDelimiterUsedForOnlyString(boolean delimiterUsedForOnlyString)	Sets whether the delimiter is only used for string data types.
void	setEnumerationLabelExported(boolean enumerationLabelExported)	Sets whether the exported file will contain an information column with the label of the enumeration.
void	setFileEncoding(String fileEncoding)	Sets the character encoding to use.
void	setForeignKeyLabelExported(boolean foreignKeyLabelExported)	Sets whether the exported file contains an information column with the foreign key label.
void	setLocaleForNumberFormat(Locale localeForFormattingNumbers)	Sets the locale and the corresponding number format policy used in the exported file.
void	setLocaleForNumberFormatUsed(boolean localeForFormattingNumbersUsed)	Sets whether the language and corresponding number format policy are applied.
void	setPrimaryKeyLabelExported(boolean primaryKeyLabelExported)	Sets whether the exported file contains an information column with the label of the primary key.
void	setSeparator(String separator)	Sets the separator character.
void	setSeparatorUsedForValuesList(String separatorUsedForValuesList)	Sets the separator character to use for value lists.

Methods inherited from class com.orchestranetworks.addon.dex.configuration.FileExportConfigurationSpec

getCurrentDataset, getCurrentTable, getLocale, getSession, isComputedValueIncluded, isDataFromReferencedTablesExported, isDataReferencingSelectedRecordExported, isHeaderExported, isWriteAccessLockDisabled, setComputedValueIncluded, setDataFromReferencedTablesExported, setDataReferencingSelectedRecordExported, setHeaderExported, setLocale, setWriteAccessLockDisabled

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CSVExportConfigurationSpec

public CSVExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext)
                           throws DataExchangeException

Throws:

DataExchangeException

CSVExportConfigurationSpec

public CSVExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable,
 TableFilter tableFilter,
 com.orchestranetworks.service.Session session)
                           throws DataExchangeException

Throws:

DataExchangeException

CSVExportConfigurationSpec

public CSVExportConfigurationSpec(EBXTable sourceTable,
 TableFilter tableFilter,
 com.orchestranetworks.service.Session session)
                           throws DataExchangeException

Throws:

DataExchangeException

Method Details

getServiceType

public ServiceType getServiceType()

Returns the service type.

getSeparator

public String getSeparator()

Returns the separator character.

setSeparator

public void setSeparator(String separator)

Sets the separator character.

getSeparatorUsedForValuesList

public String getSeparatorUsedForValuesList()

Returns the separator character to use for value lists.

setSeparatorUsedForValuesList

public void setSeparatorUsedForValuesList(String separatorUsedForValuesList)

Sets the separator character to use for value lists.

getFileEncoding

public String getFileEncoding()

Returns the character encoding to use.

setFileEncoding

public void setFileEncoding(String fileEncoding)

Sets the character encoding to use.

getDelimiter

public String getDelimiter()

Returns the character used to mark the beginning and end of a cell in the CSV file.

setDelimiter

public void setDelimiter(String delimiter)

Sets the character is used to mark the beginning and end of a cell in the CSV file.

isDelimiterUsedForOnlyString

public boolean isDelimiterUsedForOnlyString()

Returns true if the delimiter is only used for string data types.

setDelimiterUsedForOnlyString

public void setDelimiterUsedForOnlyString(boolean delimiterUsedForOnlyString)

Sets whether the delimiter is only used for string data types.

isPrimaryKeyLabelExported

public boolean isPrimaryKeyLabelExported()

Returns true if the exported file contains an information column with the primary key label.

setPrimaryKeyLabelExported

public void setPrimaryKeyLabelExported(boolean primaryKeyLabelExported)

Sets whether the exported file contains an information column with the label of the primary key.

isForeignKeyLabelExported

public boolean isForeignKeyLabelExported()

Returns true if the exported file contains an information column with the foreign key label.

setForeignKeyLabelExported

public void setForeignKeyLabelExported(boolean foreignKeyLabelExported)

Sets whether the exported file contains an information column with the foreign key label.

isLocaleForNumberFormatUsed

public boolean isLocaleForNumberFormatUsed()

Returns true if the language and corresponding number format policy are applied.

setLocaleForNumberFormatUsed

public void setLocaleForNumberFormatUsed(boolean localeForFormattingNumbersUsed)

Sets whether the language and corresponding number format policy are applied.

getLocaleForNumberFormat

public Locale getLocaleForNumberFormat()

Returns the locale and the corresponding number format policy used in the exported file.

setLocaleForNumberFormat

public void setLocaleForNumberFormat(Locale localeForFormattingNumbers)

Sets the locale and the corresponding number format policy used in the exported file.

getDateTimePatterns

public Map<Field,String> getDateTimePatterns()

Returns a map of date time patterns and Field instance as the key parameter.

setDateTimePatterns

public void setDateTimePatterns(Map<Field,String> dateTimePatterns)

Sets a map of date time patterns and Field instance as the key parameter.

getSourceTables

public List<EBXTable> getSourceTables()

Returns the list of source tables.

getSourceTableFilters

public Map<EBXTable,TableFilter> getSourceTableFilters()

Returns a map of table filters and EBXTable instance as the key parameter. Returns null when importing CSV, Excel or XML.

isEnumerationLabelExported

public boolean isEnumerationLabelExported()

Returns true if the exported file will contain an information column with the label of the enumeration.

Since:

2.6.3

setEnumerationLabelExported

public void setEnumerationLabelExported(boolean enumerationLabelExported)

Sets whether the exported file will contain an information column with the label of the enumeration.

Since:

2.6.3