Package com.orchestranetworks.addon.dex.configuration

Class TransferConfigurationSpec

java.lang.Object
com.orchestranetworks.addon.dex.configuration.TransferConfigurationSpec
All Implemented Interfaces:
ConfigurationSpec<EBXTable>, ImportConfigurationSpec<EBXTable>
public final class TransferConfigurationSpec extends Object implements ImportConfigurationSpec<EBXTable>
Specifies the configuration used for data transfer.
Since:
2.3.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    TransferConfigurationSpec(com.onwbp.adaptation.Adaptation sourceDataset, List<EBXTable> sourceTables, com.onwbp.adaptation.Adaptation targetDataset, com.orchestranetworks.service.Session session)
    Transfers multiple tables based on the specified source tables outside of a UIService.
    TransferConfigurationSpec(com.onwbp.adaptation.Adaptation sourceDataset, List<EBXTable> sourceTables, Map<EBXTable,TableFilter> sourceTableFilters, com.onwbp.adaptation.Adaptation targetDataset, com.orchestranetworks.service.Session session)
    Transfers multiple tables based on the filtered source tables outside of a UIService.
    TransferConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, com.onwbp.adaptation.Adaptation targetDataset, com.orchestranetworks.service.Session session)
    Transfers a table and is used outside of a UIService.
    TransferConfigurationSpec(DataExchangeServiceContext dexServiceContext)
    Transfers tables based on a DataExchangeServiceContext.
    TransferConfigurationSpec(EBXTable sourceTable, TableFilter tableFilter, com.onwbp.adaptation.Adaptation targetDataset, com.orchestranetworks.service.Session session)
    Transfers a table with filter and is used outside of a UIService.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.onwbp.adaptation.Adaptation
    getCurrentDataset()
    Returns the current dataset.
    com.onwbp.adaptation.AdaptationTable
    getCurrentTable()
    Returns the current table.
    ImportMode
    getImportMode()
    Returns the specified import mode.
    ServiceType
    getServiceType()
    Returns the service type.
    com.orchestranetworks.service.Session
    getSession()
    Returns the current session.
    Map<EBXTable,TableFilter>
    getSourceTableFilters()
    Returns a map of table filters and a Table instance as the key parameter.
    List<EBXTable>
    getSourceTables()
    Returns the list of source tables.
    com.onwbp.adaptation.Adaptation
    getTargetDataset()
    Returns the target dataset.
    final boolean
    isComputedValueIncluded()
    Returns true if the computed values on the source tables are transferred to the target tables.
    boolean
    isCreateSnapshot()
    Returns true if want to create snapshot before transferring data.
    boolean
    isEmptyOrNullPrimaryKeyChecked()
    Returns true if all empty or null primary keys were checked before data import and false if this verification was not performed.
    boolean
    isEmptyOrNullValueIgnored()
    Returns true if all empty or null values are ignored in the process of importing data.
    boolean
    isImportForced()
    Returns true if all triggers and constraints are disabled in the process of importing data.
    boolean
    isStopAndRollBackOnError()
    Returns true if all executed transfers have been successful and the whole transaction committed.
    final void
    setComputedValueIncluded(boolean computedValueIncluded)
    Sets whether to transfer the computed values on the source tables to the target tables.
    void
    setCreateSnapshot(boolean createSnapshot)
    Sets false if the transfer is initiated from a running procedure.
    final void
    setEmptyOrNullPrimaryKeyChecked(boolean emptyOrNullPrimaryKeyChecked)
    Sets whether all empty or null primary keys were checked before data import and false if this verification was not performed.
    final void
    setEmptyOrNullValueIgnored(boolean emptyOrNullValueIgnored)
    Sets whether all empty or null values are ignored in the process of importing data.
    final void
    setImportForced(boolean importForced)
    Sets whether all triggers and constraints are disabled in the process of importing data.
    final void
    setImportMode(ImportMode importMode)
    Sets the import mode.
    void
    setStopAndRollBackOnError(boolean stopAndRollBackOnError)
    Sets whether the all executed transfers have been successful and the whole transaction committed.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TransferConfigurationSpec

      public TransferConfigurationSpec(com.onwbp.adaptation.Adaptation sourceDataset, List<EBXTable> sourceTables, com.onwbp.adaptation.Adaptation targetDataset, com.orchestranetworks.service.Session session) throws DataExchangeException
      Transfers multiple tables based on the specified source tables outside of a UIService.
      Throws:
      DataExchangeException

    • TransferConfigurationSpec

      public TransferConfigurationSpec(com.onwbp.adaptation.Adaptation sourceDataset, List<EBXTable> sourceTables, Map<EBXTable,TableFilter> sourceTableFilters, com.onwbp.adaptation.Adaptation targetDataset, com.orchestranetworks.service.Session session) throws DataExchangeException
      Transfers multiple tables based on the filtered source tables outside of a UIService.
      Throws:
      DataExchangeException

    • TransferConfigurationSpec

      public TransferConfigurationSpec(DataExchangeServiceContext dexServiceContext) throws DataExchangeException
      Transfers tables based on a DataExchangeServiceContext.
      Throws:
      DataExchangeException
      Since:
      2.4.0

    • TransferConfigurationSpec

      public TransferConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, com.onwbp.adaptation.Adaptation targetDataset, com.orchestranetworks.service.Session session) throws DataExchangeException
      Transfers a table and is used outside of a UIService.
      Throws:
      DataExchangeException
      Since:
      2.4.0

    • TransferConfigurationSpec

      public TransferConfigurationSpec(EBXTable sourceTable, TableFilter tableFilter, com.onwbp.adaptation.Adaptation targetDataset, com.orchestranetworks.service.Session session) throws DataExchangeException
      Transfers a table with filter and is used outside of a UIService.
      Throws:
      DataExchangeException
      Since:
      2.4.0

  • Method Details

    • getServiceType

      public ServiceType getServiceType()
      Returns the service type.
      Specified by:
      getServiceType in interface ConfigurationSpec<EBXTable>

    • isImportForced

      public boolean isImportForced()
      Returns true if all triggers and constraints are disabled in the process of importing data.
      Specified by:
      isImportForced in interface ImportConfigurationSpec<EBXTable>

    • setImportForced

      public final void setImportForced(boolean importForced)
      Sets whether all triggers and constraints are disabled in the process of importing data.

    • getImportMode

      public ImportMode getImportMode()
      Returns the specified import mode.
      Specified by:
      getImportMode in interface ImportConfigurationSpec<EBXTable>

    • setImportMode

      public final void setImportMode(ImportMode importMode)
      Sets the import mode.

    • isEmptyOrNullValueIgnored

      public boolean isEmptyOrNullValueIgnored()
      Returns true if all empty or null values are ignored in the process of importing data.
      Specified by:
      isEmptyOrNullValueIgnored in interface ImportConfigurationSpec<EBXTable>

    • setEmptyOrNullValueIgnored

      public final void setEmptyOrNullValueIgnored(boolean emptyOrNullValueIgnored)
      Sets whether all empty or null values are ignored in the process of importing data.

    • isComputedValueIncluded

      public final boolean isComputedValueIncluded()
      Returns true if the computed values on the source tables are transferred to the target tables.
      Since:
      2.4.0

    • setComputedValueIncluded

      public final void setComputedValueIncluded(boolean computedValueIncluded)
      Sets whether to transfer the computed values on the source tables to the target tables.
      Since:
      2.4.0

    • isEmptyOrNullPrimaryKeyChecked

      public boolean isEmptyOrNullPrimaryKeyChecked()
      Returns true if all empty or null primary keys were checked before data import and false if this verification was not performed.
      Specified by:
      isEmptyOrNullPrimaryKeyChecked in interface ImportConfigurationSpec<EBXTable>

    • setEmptyOrNullPrimaryKeyChecked

      public final void setEmptyOrNullPrimaryKeyChecked(boolean emptyOrNullPrimaryKeyChecked)
      Sets whether all empty or null primary keys were checked before data import and false if this verification was not performed.

    • getTargetDataset

      public com.onwbp.adaptation.Adaptation getTargetDataset()
      Returns the target dataset.

    • getSourceTables

      public List<EBXTable> getSourceTables()
      Returns the list of source tables.
      Specified by:
      getSourceTables in interface ConfigurationSpec<EBXTable>

    • getSourceTableFilters

      public Map<EBXTable,TableFilter> getSourceTableFilters()
      Returns a map of table filters and a Table instance as the key parameter. Returns null when importing CSV, Excel and XML.
      Specified by:
      getSourceTableFilters in interface ConfigurationSpec<EBXTable>

    • getCurrentDataset

      public com.onwbp.adaptation.Adaptation getCurrentDataset()
      Returns the current dataset.
      Specified by:
      getCurrentDataset in interface ConfigurationSpec<EBXTable>

    • getCurrentTable

      public com.onwbp.adaptation.AdaptationTable getCurrentTable()
      Returns the current table.
      Specified by:
      getCurrentTable in interface ConfigurationSpec<EBXTable>

    • getSession

      public com.orchestranetworks.service.Session getSession()
      Returns the current session.
      Specified by:
      getSession in interface ConfigurationSpec<EBXTable>

    • isStopAndRollBackOnError

      public boolean isStopAndRollBackOnError()
      Returns true if all executed transfers have been successful and the whole transaction committed.
      Since:
      2.5.0

    • setStopAndRollBackOnError

      public void setStopAndRollBackOnError(boolean stopAndRollBackOnError)
      Sets whether the all executed transfers have been successful and the whole transaction committed.
      Since:
      2.5.0

    • isCreateSnapshot

      public boolean isCreateSnapshot()
      Returns true if want to create snapshot before transferring data.
      Since:
      6.2.1.hf3

    • setCreateSnapshot

      public void setCreateSnapshot(boolean createSnapshot)
      Sets false if the transfer is initiated from a running procedure.
      Since:
      6.2.1.hf3