CSVImportConfigurationSpec (EBX® Add-ons Version 5.3.0 Java API)

java.lang.Object
- com.orchestranetworks.addon.dex.configuration.FileImportConfigurationSpec<CSVTable>
- - com.orchestranetworks.addon.dex.configuration.CSVImportConfigurationSpec

All Implemented Interfaces:

ConfigurationSpec<CSVTable>, ImportConfigurationSpec<CSVTable>
```
public final class CSVImportConfigurationSpec
extends FileImportConfigurationSpec<CSVTable>
```
Specifies the configuration used when importing data from a CSV file.

Since:

2.3.0

Constructor Summary

Constructors
Constructor and Description
`CSVImportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, CSVTable csvTable, com.orchestranetworks.service.Session session)`
`CSVImportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, com.orchestranetworks.service.Session session)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.onwbp.adaptation.Adaptation`	`getCurrentDataset()` Returns the current dataset.
`com.onwbp.adaptation.AdaptationTable`	`getCurrentTable()` Returns the current table.
`Map<Field,String>`	`getDateTimePatterns()` Returns a map of date time patterns and `Field` instance as the key parameter.
`DecimalSymbol`	`getDecimalSymbol()` Returns the decimal symbol.
`String`	`getDelimiter()` Returns the character is used to mark the beginning and end of a cell in the CSV file.
`String`	`getFileEncoding()` Returns the character encoding to use.
`LineReturnCharacters`	`getLineReturnCharacters()` Returns the line return characters.
`String`	`getSeparator()` Returns the separator character.
`String`	`getSeparatorUsedForValuesList()` Returns the separator character to use for values lists.
`ServiceType`	`getServiceType()` Returns the service type.
`com.orchestranetworks.service.Session`	`getSession()` Returns the current session.
`Map<CSVTable,TableFilter>`	`getSourceTableFilters()` Returns a map of table filters and `EBXTable` instance as the key parameter.
`List<CSVTable>`	`getSourceTables()` Returns the list of source tables.
`boolean`	`isDataValidatedBeforeTransformation()` Returns `true` if the import data is validated before transformation executing.
`boolean`	`isDelimiterForOnlyStringUsed()` Returns `true` if the delimiter is only used for string data types.
`boolean`	`isHeaderComparedToIgnoreCase()` Return `true` if case-insensitive comparison is used when matching the header column.
`boolean`	`isImportOnlyValidRecord()` Returns `true` if validation errors exist and the user chooses import only valid records.
`boolean`	`isRedundantCharactersInHeaderRemoved()` Return `true` if redundant characters contained in the header are removed during matching.
`void`	`setDataValidatedBeforeTransformation(boolean isDataValidated)` Sets whether the import data is validated before transformation executing.
`void`	`setDateTimePatterns(Map<Field,String> dateTimePatterns)` Sets a map of date time patterns and `Field` instance as the key parameter.
`void`	`setDecimalSymbol(DecimalSymbol decimalSymbol)` Sets the decimal symbol.
`void`	`setDelimiter(String delimiter)` Sets the character is used to mark the beginning and end of a cell in the CSV file.
`void`	`setDelimiterForOnlyStringUsed(boolean delimiterForOnlyStringUsed)` Sets whether the delimiter is only used for string data types.
`void`	`setFileEncoding(String fileEncoding)` Sets the character encoding to use.
`void`	`setHeaderComparedToIgnoreCase(boolean headerComparedToIgnoreCase)` Sets whether case-insensitive comparison is used when matching the header column.
`void`	`setImportOnlyValidRecord(boolean importOnlyValidRecord)` Sets whether the validation errors exist and the user chooses import only valid records.
`void`	`setLineReturnCharacters(LineReturnCharacters lineReturnCharacters)` Sets the line return characters.
`void`	`setRedundantCharactersInHeaderRemoved(boolean redundantCharactersInHeaderRemoved)` Sets whether redundant characters contained in the header are removed during matching.
`void`	`setSeparator(String separator)` Sets the separator character.
`void`	`setSeparatorUsedForValuesList(String separatorUsedForValuesList)` Sets the separator character to use for values lists.

Methods inherited from class com.orchestranetworks.addon.dex.configuration.FileImportConfigurationSpec
getErrorFilePath, getImportedFile, getImportMode, isEmptyOrNullPrimaryKeyChecked, isEmptyOrNullValueIgnored, isHeaderUsed, isImportForced, isInvalidDataDownloaded, setEmptyOrNullPrimaryKeyChecked, setEmptyOrNullValueIgnored, setErrorFilePath, setHeaderUsed, setImportedFile, setImportForced, setImportMode, setInvalidDataDownloaded

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CSVImportConfigurationSpec
```
public CSVImportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable,
                                  com.orchestranetworks.service.Session session)
                           throws DataExchangeException
```
    Throws:
    
    DataExchangeException
  - CSVImportConfigurationSpec
```
public CSVImportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable,
                                  CSVTable csvTable,
                                  com.orchestranetworks.service.Session session)
                           throws DataExchangeException
```
    Throws:
    
    DataExchangeException
- Method Detail
  - 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 values lists.
  - setSeparatorUsedForValuesList
```
public void setSeparatorUsedForValuesList(String separatorUsedForValuesList)
```
    Sets the separator character to use for values 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 is 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.
  - isDelimiterForOnlyStringUsed
```
public boolean isDelimiterForOnlyStringUsed()
```
    Returns true if the delimiter is only used for string data types.
  - setDelimiterForOnlyStringUsed
```
public void setDelimiterForOnlyStringUsed(boolean delimiterForOnlyStringUsed)
```
    Sets whether the delimiter is only used for string data types.
  - getDecimalSymbol
```
public DecimalSymbol getDecimalSymbol()
```
    Returns the decimal symbol.
  - setDecimalSymbol
```
public void setDecimalSymbol(DecimalSymbol decimalSymbol)
```
    Sets the decimal symbol.
  - isHeaderComparedToIgnoreCase
```
public boolean isHeaderComparedToIgnoreCase()
```
    Return true if case-insensitive comparison is used when matching the header column.
  - setHeaderComparedToIgnoreCase
```
public void setHeaderComparedToIgnoreCase(boolean headerComparedToIgnoreCase)
```
    Sets whether case-insensitive comparison is used when matching the header column.
  - isRedundantCharactersInHeaderRemoved
```
public boolean isRedundantCharactersInHeaderRemoved()
```
    Return true if redundant characters contained in the header are removed during matching.
  - setRedundantCharactersInHeaderRemoved
```
public void setRedundantCharactersInHeaderRemoved(boolean redundantCharactersInHeaderRemoved)
```
    Sets whether redundant characters contained in the header are removed during matching.
  - 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.
  - getCurrentDataset
```
public com.onwbp.adaptation.Adaptation getCurrentDataset()
```
    Returns the current dataset.
  - getCurrentTable
```
public com.onwbp.adaptation.AdaptationTable getCurrentTable()
```
    Returns the current table.
  - getSession
```
public com.orchestranetworks.service.Session getSession()
```
    Returns the current session.
  - getSourceTables
```
public List<CSVTable> getSourceTables()
```
    Returns the list of source tables.
  - getSourceTableFilters
```
public Map<CSVTable,TableFilter> getSourceTableFilters()
```
    Returns a map of table filters and EBXTable instance as the key parameter. Returns null in case of importing CSV, Excel and XML.
  - isDataValidatedBeforeTransformation
```
public boolean isDataValidatedBeforeTransformation()
```
    Returns true if the import data is validated before transformation executing.
  - setDataValidatedBeforeTransformation
```
public void setDataValidatedBeforeTransformation(boolean isDataValidated)
```
    Sets whether the import data is validated before transformation executing.
  - setImportOnlyValidRecord
```
public void setImportOnlyValidRecord(boolean importOnlyValidRecord)
```
    Sets whether the validation errors exist and the user chooses import only valid records.
  - isImportOnlyValidRecord
```
public boolean isImportOnlyValidRecord()
```
    Returns true if validation errors exist and the user chooses import only valid records.
  - getLineReturnCharacters
```
public LineReturnCharacters getLineReturnCharacters()
```
    Returns the line return characters.
    
    Since:
    
    2.4.0
  - setLineReturnCharacters
```
public void setLineReturnCharacters(LineReturnCharacters lineReturnCharacters)
```
    Sets the line return characters.
    
    Since:
    
    2.4.0

EBX® Add-ons Version 5.3.0.

Copyright TIBCO Software Inc. 2001-2022. All rights reserved.
All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Class CSVImportConfigurationSpec

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CSVImportConfigurationSpec

CSVImportConfigurationSpec

Method Detail

getServiceType

getSeparator

setSeparator

getSeparatorUsedForValuesList

setSeparatorUsedForValuesList

getFileEncoding

setFileEncoding

getDelimiter

setDelimiter

isDelimiterForOnlyStringUsed

setDelimiterForOnlyStringUsed

getDecimalSymbol

setDecimalSymbol

isHeaderComparedToIgnoreCase

setHeaderComparedToIgnoreCase

isRedundantCharactersInHeaderRemoved

setRedundantCharactersInHeaderRemoved

getDateTimePatterns

setDateTimePatterns

getCurrentDataset

getCurrentTable

getSession

getSourceTables

getSourceTableFilters

isDataValidatedBeforeTransformation

setDataValidatedBeforeTransformation

setImportOnlyValidRecord

isImportOnlyValidRecord

getLineReturnCharacters

setLineReturnCharacters