Package com.orchestranetworks.addon.dex.configuration

Class SQLExportConfigurationSpec

java.lang.Object

com.orchestranetworks.addon.dex.configuration.SQLExportConfigurationSpec

All Implemented Interfaces:

ConfigurationSpec<EBXTable>, ExportConfigurationSpec<EBXTable>

public final class SQLExportConfigurationSpec
extends Object
implements ExportConfigurationSpec<EBXTable>

Defines the configuration used to export data to an external database.

Since:

2.3.0

Constructor Summary

Constructors

Constructor	Description
SQLExportConfigurationSpec(com.onwbp.adaptation.Adaptation recordOrDataset, List<EBXTable> sourceTables, JNDIDataSource jndiDataSource, com.orchestranetworks.service.Session session)	Exports multiple tables with JNDIDataSource outside of a UIService.
SQLExportConfigurationSpec(com.onwbp.adaptation.Adaptation recordOrDataset, List<EBXTable> sourceTables, String sqlDataSourceName, com.orchestranetworks.service.Session session)	Exports multiple tables outside of a UIService.
SQLExportConfigurationSpec(com.onwbp.adaptation.Adaptation dataset, List<EBXTable> sourceTables, Map<EBXTable,TableFilter> tableFilters, JNDIDataSource jndiDataSource, com.orchestranetworks.service.Session session)	Exports multiple tables with a filter and JNDIDataSource outside of a UIService.
SQLExportConfigurationSpec(com.onwbp.adaptation.Adaptation dataset, List<EBXTable> sourceTables, Map<EBXTable,TableFilter> tableFilters, String sqlDataSourceName, com.orchestranetworks.service.Session session)	Exports multiple tables with a filter outside of a UIService.
SQLExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, JNDIDataSource jndiDataSource, com.orchestranetworks.service.Session session)	Exports a table with JNDIDataSource outside of a UIService.
SQLExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, TableFilter tableFilter, JNDIDataSource jndiDataSource, com.orchestranetworks.service.Session session)	Exports a table with filter and JNDIDataSource outside of a UIService.
SQLExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, TableFilter tableFilter, String sqlDataSourceName, com.orchestranetworks.service.Session session)	Exports a table with filter outside of a UIService.
SQLExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable, String sqlDataSourceName, com.orchestranetworks.service.Session session)	Exports a table outside of a UIService.
SQLExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext, JNDIDataSource jndiDataSource)	Exports a table with JNDIDataSource within a UIService.
SQLExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext, String sqlDataSourceName)	Exports a table within 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.
Map<TableMapping,FieldMapperDefinition>	getFieldMapperDefinitions()	Returns the map of the FieldMapperDefinition implementations and a TableMapping instance as the key parameter.
JNDIDataSource	getJNDIDataSource()	Returns the specified JNDI data source for SQL export.
String	getSchemaName()	Returns the the specified schema name.
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 an instance of EBXTable as the key parameter.
List<EBXTable>	getSourceTables()	Returns the list of source tables.
String	getSQLDataSourceName()	Returns the SQL data source name.
ImportMode	getSQLImportMode()	Returns the import mode.
String	getTablePattern()	Returns the specified table naming pattern.
boolean	isComputedValueIncluded()	Returns true if the exported data contains computed values.
boolean	isWriteAccessLockDisabled()	Deprecated. Since 3.0.0, the 'Disable write access lock' option was removed from the add-on.
void	setComputedValueIncluded(boolean computedValueIncluded)	Sets whether to include computed values in the exported data.
void	setFieldMapperDefinitions(Map<TableMapping,FieldMapperDefinition> fieldMapperDefinitions)	Sets a map of the FieldMapperDefinition implementations and a TableMapping instance as the key parameter.
void	setSchemaName(String schemaName)	Sets the the specified schema name.
void	setSQLImportMode(ImportMode sqlImportMode)	Sets the import mode.
void	setTablePattern(String tablePattern)	Sets a table naming pattern.
void	setWriteAccessLockDisabled(boolean writeAccessLockDisabled)	Deprecated. Since 3.0.0, the 'Disable write access lock' option was removed from the add-on.

Methods inherited from class java.lang.Object

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

Constructor Details

SQLExportConfigurationSpec

public SQLExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext,
 String sqlDataSourceName)
                           throws DataExchangeException

Exports a table within a UIService.

Throws:

DataExchangeException

SQLExportConfigurationSpec

public SQLExportConfigurationSpec(com.orchestranetworks.service.ServiceContext serviceContext,
 JNDIDataSource jndiDataSource)
                           throws DataExchangeException

Exports a table with JNDIDataSource within a UIService.

Throws:

DataExchangeException

Since:

2.5.0

SQLExportConfigurationSpec

public SQLExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable,
 String sqlDataSourceName,
 com.orchestranetworks.service.Session session)
                           throws DataExchangeException

Exports a table outside of a UIService.

Throws:

DataExchangeException

SQLExportConfigurationSpec

public SQLExportConfigurationSpec(com.onwbp.adaptation.AdaptationTable currentTable,
 JNDIDataSource jndiDataSource,
 com.orchestranetworks.service.Session session)
                           throws DataExchangeException

Exports a table with JNDIDataSource outside of a UIService.

Throws:

DataExchangeException

Since:

2.5.0

SQLExportConfigurationSpec

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

Exports a table with filter outside of a UIService.

Throws:

DataExchangeException

SQLExportConfigurationSpec

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

Exports a table with filter and JNDIDataSource outside of a UIService.

Throws:

DataExchangeException

Since:

2.5.0

SQLExportConfigurationSpec

public SQLExportConfigurationSpec(com.onwbp.adaptation.Adaptation recordOrDataset,
 List<EBXTable> sourceTables,
 String sqlDataSourceName,
 com.orchestranetworks.service.Session session)
                           throws DataExchangeException

Exports multiple tables outside of a UIService.

Throws:

DataExchangeException

SQLExportConfigurationSpec

public SQLExportConfigurationSpec(com.onwbp.adaptation.Adaptation recordOrDataset,
 List<EBXTable> sourceTables,
 JNDIDataSource jndiDataSource,
 com.orchestranetworks.service.Session session)
                           throws DataExchangeException

Exports multiple tables with JNDIDataSource outside of a UIService.

Throws:

DataExchangeException

Since:

2.5.0

SQLExportConfigurationSpec

public SQLExportConfigurationSpec(com.onwbp.adaptation.Adaptation dataset,
 List<EBXTable> sourceTables,
 Map<EBXTable,TableFilter> tableFilters,
 String sqlDataSourceName,
 com.orchestranetworks.service.Session session)
                           throws DataExchangeException

Exports multiple tables with a filter outside of a UIService.

Throws:

DataExchangeException

SQLExportConfigurationSpec

public SQLExportConfigurationSpec(com.onwbp.adaptation.Adaptation dataset,
 List<EBXTable> sourceTables,
 Map<EBXTable,TableFilter> tableFilters,
 JNDIDataSource jndiDataSource,
 com.orchestranetworks.service.Session session)
                           throws DataExchangeException

Exports multiple tables with a filter and JNDIDataSource outside of a UIService.

Throws:

DataExchangeException

Since:

2.5.0

Method Details

isComputedValueIncluded

public boolean isComputedValueIncluded()

Returns true if the exported data contains computed values.

Specified by:

isComputedValueIncluded in interface ExportConfigurationSpec<EBXTable>

setComputedValueIncluded

public void setComputedValueIncluded(boolean computedValueIncluded)

Sets whether to include computed values in the exported data.

getServiceType

public ServiceType getServiceType()

Returns the service type.

Specified by:

getServiceType in interface ConfigurationSpec<EBXTable>

isWriteAccessLockDisabled

public boolean isWriteAccessLockDisabled()

Deprecated.

Since 3.0.0, the 'Disable write access lock' option was removed from the add-on.

Always throws exception.

Specified by:

isWriteAccessLockDisabled in interface ExportConfigurationSpec<EBXTable>

setWriteAccessLockDisabled

public void setWriteAccessLockDisabled(boolean writeAccessLockDisabled)

Deprecated.

Since 3.0.0, the 'Disable write access lock' option was removed from the add-on.

Always throws exception.

getSQLImportMode

public ImportMode getSQLImportMode()

Returns the import mode.

setSQLImportMode

public void setSQLImportMode(ImportMode sqlImportMode)

Sets the import mode.

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>

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 an instance of EBXTable as the key parameter. Returns null when importing CSV, Excel and XML.

Specified by:

getSourceTableFilters in interface ConfigurationSpec<EBXTable>

getSQLDataSourceName

public String getSQLDataSourceName()

Returns the SQL data source name.

getFieldMapperDefinitions

public Map<TableMapping,FieldMapperDefinition> getFieldMapperDefinitions()

Returns the map of the FieldMapperDefinition implementations and a TableMapping instance as the key parameter.

setFieldMapperDefinitions

public void setFieldMapperDefinitions(Map<TableMapping,FieldMapperDefinition> fieldMapperDefinitions)

Sets a map of the FieldMapperDefinition implementations and a TableMapping instance as the key parameter.

getTablePattern

public String getTablePattern()

Returns the specified table naming pattern.

setTablePattern

public void setTablePattern(String tablePattern)

Sets a table naming pattern.

getSchemaName

public String getSchemaName()

Returns the the specified schema name.

setSchemaName

public void setSchemaName(String schemaName)

Sets the the specified schema name.

getJNDIDataSource

public JNDIDataSource getJNDIDataSource()

Returns the specified JNDI data source for SQL export.

Since:

2.5.0