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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<Field,java.lang.String>
getDateTimePatterns()
Returns a map of date time patterns andField
instance as the key parameter.java.lang.String
getDelimiter()
Returns the character used to mark the beginning and end of a cell in the CSV file.java.lang.String
getFileEncoding()
Returns the character encoding to use.java.util.Locale
getLocaleForNumberFormat()
Returns the locale and the corresponding number format policy used in the exported file.java.lang.String
getSeparator()
Returns the separator character.java.lang.String
getSeparatorUsedForValuesList()
Returns the separator character to use for value lists.ServiceType
getServiceType()
Returns the service type.java.util.Map<EBXTable,TableFilter>
getSourceTableFilters()
Returns a map of table filters andEBXTable
instance as the key parameter.java.util.List<EBXTable>
getSourceTables()
Returns the list of source tables.boolean
isDelimiterUsedForOnlyString()
Returnstrue
if the delimiter is only used for string data types.boolean
isEnumerationLabelExported()
Returnstrue
if the exported file will contain an information column with the label of the enumeration.boolean
isForeignKeyLabelExported()
Returnstrue
if the exported file contains an information column with the foreign key label.boolean
isLocaleForNumberFormatUsed()
Returnstrue
if the language and corresponding number format policy are applied.boolean
isPrimaryKeyLabelExported()
Returnstrue
if the exported file contains an information column with the primary key label.void
setDateTimePatterns(java.util.Map<Field,java.lang.String> dateTimePatterns)
Sets a map of date time patterns andField
instance as the key parameter.void
setDelimiter(java.lang.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(java.lang.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(java.util.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(java.lang.String separator)
Sets the separator character.void
setSeparatorUsedForValuesList(java.lang.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
-
-
-
-
Constructor Detail
-
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 Detail
-
getServiceType
public ServiceType getServiceType()
Returns the service type.
-
getSeparator
public java.lang.String getSeparator()
Returns the separator character.
-
setSeparator
public void setSeparator(java.lang.String separator)
Sets the separator character.
-
getSeparatorUsedForValuesList
public java.lang.String getSeparatorUsedForValuesList()
Returns the separator character to use for value lists.
-
setSeparatorUsedForValuesList
public void setSeparatorUsedForValuesList(java.lang.String separatorUsedForValuesList)
Sets the separator character to use for value lists.
-
getFileEncoding
public java.lang.String getFileEncoding()
Returns the character encoding to use.
-
setFileEncoding
public void setFileEncoding(java.lang.String fileEncoding)
Sets the character encoding to use.
-
getDelimiter
public java.lang.String getDelimiter()
Returns the character used to mark the beginning and end of a cell in the CSV file.
-
setDelimiter
public void setDelimiter(java.lang.String delimiter)
Sets the character is used to mark the beginning and end of a cell in the CSV file.
-
isDelimiterUsedForOnlyString
public boolean isDelimiterUsedForOnlyString()
Returnstrue
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()
Returnstrue
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()
Returnstrue
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()
Returnstrue
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 java.util.Locale getLocaleForNumberFormat()
Returns the locale and the corresponding number format policy used in the exported file.
-
setLocaleForNumberFormat
public void setLocaleForNumberFormat(java.util.Locale localeForFormattingNumbers)
Sets the locale and the corresponding number format policy used in the exported file.
-
getDateTimePatterns
public java.util.Map<Field,java.lang.String> getDateTimePatterns()
Returns a map of date time patterns andField
instance as the key parameter.
-
setDateTimePatterns
public void setDateTimePatterns(java.util.Map<Field,java.lang.String> dateTimePatterns)
Sets a map of date time patterns andField
instance as the key parameter.
-
getSourceTables
public java.util.List<EBXTable> getSourceTables()
Returns the list of source tables.
-
getSourceTableFilters
public java.util.Map<EBXTable,TableFilter> getSourceTableFilters()
Returns a map of table filters andEBXTable
instance as the key parameter. Returnsnull
when importing CSV, Excel or XML.
-
isEnumerationLabelExported
public boolean isEnumerationLabelExported()
Returnstrue
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
-
-