Package com.orchestranetworks.addon.dex.configuration

Class SpreadsheetImportConfigurationSpec

java.lang.Object
com.orchestranetworks.addon.dex.configuration.FileImportConfigurationSpec<SpreadsheetTable>
com.orchestranetworks.addon.dex.configuration.SpreadsheetImportConfigurationSpec
All Implemented Interfaces:
ConfigurationSpec<SpreadsheetTable>, ImportConfigurationSpec<SpreadsheetTable>
public final class SpreadsheetImportConfigurationSpec extends FileImportConfigurationSpec<SpreadsheetTable>
Defines the configuration used when importing data from an Excel file.
Since:
2.3.0

  • Constructor Details

    • SpreadsheetImportConfigurationSpec

      public SpreadsheetImportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, SpreadsheetTable spreadsheetTable, com.orchestranetworks.service.Session session) throws DataExchangeException
      Imports data into a table outside of a UIService.
      Throws:
      DataExchangeException

    • SpreadsheetImportConfigurationSpec

      public SpreadsheetImportConfigurationSpec(com.onwbp.adaptation.Adaptation dataset, List<SpreadsheetTable> sourceTables, com.orchestranetworks.service.Session session) throws DataExchangeException
      Imports data into multiple tables outside of a UIService.
      Throws:
      DataExchangeException

  • Method Details

    • getServiceType

      public ServiceType getServiceType()
      Returns the service type.

    • isHeaderComparedToIgnoreCase

      public boolean isHeaderComparedToIgnoreCase()
      Return true if a case-insensitive comparison is used when matching the header column.

    • setHeaderComparedToIgnoreCase

      public void setHeaderComparedToIgnoreCase(boolean headerComparedToIgnoreCase)
      Sets whether a 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.

    • getDataPositionInSheets

      public Map<String,DataPosition> getDataPositionInSheets()
      Returns a map of data positions and Excel sheet names as the key parameter.

    • setDataPositionInSheets

      public void setDataPositionInSheets(Map<String,DataPosition> dataPositionInSheets)
      Sets a map of data positions and Excel sheet names 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<SpreadsheetTable> getSourceTables()
      Returns the list of source tables.

    • getSourceTableFilters

      public Map<SpreadsheetTable,TableFilter> getSourceTableFilters()
      Returns a map of source table filters. Returns null when importing CSV, Excel and XML.

    • isForcePrecisionAsDisplayed

      public boolean isForcePrecisionAsDisplayed()
      Returns true if the displayed value of numbers in each cell will be read and imported. Returns false if the accuracy value of numbers in each cell will be read and imported.

    • setForcePrecisionAsDisplayed

      public void setForcePrecisionAsDisplayed(boolean forcePrecisionAsDisplayed)
      Specifies the accuracy of numbers when importing Excel. If set to true: The displayed value of numbers in each cell will be read and imported. If set to false: The accuracy value of numbers in each cell will be read and imported. This feature only applies to Number format cells (Number is used for general display of numbers). For the other cell formats, the accuracy value in each cell will be read and imported.

    • isDataBeforeTransformationValidated

      public boolean isDataBeforeTransformationValidated()
      Returns true if the import data is validated before transformation execution.

    • setDataBeforeTransformationValidated

      public void setDataBeforeTransformationValidated(boolean dataBeforeTransformationValidated)
      Sets whether the import data is validated before transformation execution.

    • isImportSequence

      public boolean isImportSequence()
      Returns true if the Excel sheet data are imported sequentially at simulation import mode.

    • setImportSequence

      public void setImportSequence(boolean importSequence)
      Sets whether the Excel sheet data are imported sequentially at simulation import mode.

    • setImportOnlyValidRecord

      public void setImportOnlyValidRecord(boolean importOnlyValidRecord)
      Sets whether only valid records are imported if validation errors exist.

    • isImportOnlyValidRecord

      public boolean isImportOnlyValidRecord()
      Returns true if validation errors exist and the user chooses to import only valid records.