Package com.orchestranetworks.addon.dint.dataconnector.spec

Class EBXSourceTableSpec.EBXSourceTableSpecBuilder

java.lang.Object

com.orchestranetworks.addon.dint.dataconnector.spec.EBXSourceTableSpec.EBXSourceTableSpecBuilder

Enclosing class:

EBXSourceTableSpec

public static final class EBXSourceTableSpec.EBXSourceTableSpecBuilder
extends Object

Builder for creating an instance of EBXSourceTableSpec.

Method Summary

Modifier and Type	Method	Description
EBXSourceTableSpec.EBXSourceTableSpecBuilder	addUnsupportedDataTypes(DataType... dataTypes)	Adds unsupported data types.
EBXSourceTableSpec	build()	Builds an EBXSourceTableSpec instance.
EBXSourceTableSpec.EBXSourceTableSpecBuilder	setComputedValueIncluded(boolean included)	Specifies whether to include computed fields.
EBXSourceTableSpec.EBXSourceTableSpecBuilder	setEnumLabelIncluded(boolean included)	Specifies whether to include enumeration label fields.
EBXSourceTableSpec.EBXSourceTableSpecBuilder	setForeignKeyHierarchyIncluded(boolean included)	Specifies whether to include foreign key hierarchies.
EBXSourceTableSpec.EBXSourceTableSpecBuilder	setForeignKeyLabelIncluded(boolean included)	Specifies whether to include foreign key label fields.
EBXSourceTableSpec.EBXSourceTableSpecBuilder	setPrimaryKeyLabelIncluded(boolean included)	Specifies whether to include the record label as a field.
EBXSourceTableSpec.EBXSourceTableSpecBuilder	setRequest(com.onwbp.adaptation.Request request)	Sets the request to filter records in the selected table.
EBXSourceTableSpec.EBXSourceTableSpecBuilder	setStaticEnumerationIncluded(boolean included)	Specifies whether to include static enumerations.

Methods inherited from class java.lang.Object

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

Method Details

build

public EBXSourceTableSpec build()

Builds an EBXSourceTableSpec instance.

setRequest

public EBXSourceTableSpec.EBXSourceTableSpecBuilder setRequest(com.onwbp.adaptation.Request request)

Sets the request to filter records in the selected table.

setPrimaryKeyLabelIncluded

public EBXSourceTableSpec.EBXSourceTableSpecBuilder setPrimaryKeyLabelIncluded(boolean included)

Specifies whether to include the record label as a field.

If the parameter is true, SourceTable.getMappedFields() will include the primary key label field.

Parameters:

included - Sets true if you want to export primary key label.

See Also:

• EBXField.isPrimaryKeyLabelIncluded()

setForeignKeyLabelIncluded

public EBXSourceTableSpec.EBXSourceTableSpecBuilder setForeignKeyLabelIncluded(boolean included)

Specifies whether to include foreign key label fields.

If the parameter is true, SourceTable.getMappedFields() will include foreign key label fields.

Parameters:

included - Sets true if you want to export foreign key labels.

See Also:

• EBXField.isForeignKeyLabel()

setEnumLabelIncluded

public EBXSourceTableSpec.EBXSourceTableSpecBuilder setEnumLabelIncluded(boolean included)

Specifies whether to include enumeration label fields.

If the parameter is true, SourceTable.getMappedFields() will include enumeration label fields.

Parameters:

included - Sets true if you want to export enumeration labels.

See Also:

• EBXField.isEnumLabel()

setForeignKeyHierarchyIncluded

public EBXSourceTableSpec.EBXSourceTableSpecBuilder setForeignKeyHierarchyIncluded(boolean included)

Specifies whether to include foreign key hierarchies.

If the parameter is true and in case of composite foreign key, a foreign key field returned from SourceTable.getMappedFields() will have children for all primary keys in referred table.

In case both the source table and the target table are EBXTable, this should be set to false to configure foreign keys as normal fields, not hierarchies.

Parameters:

included - Sets true if you want to include foreign key hierarchies.

setComputedValueIncluded

public EBXSourceTableSpec.EBXSourceTableSpecBuilder setComputedValueIncluded(boolean included)

Specifies whether to include computed fields.

Parameters:

included - Sets true if you want to include computed field.

setStaticEnumerationIncluded

public EBXSourceTableSpec.EBXSourceTableSpecBuilder setStaticEnumerationIncluded(boolean included)

Specifies whether to include static enumerations.

This action is taken only when the target can display a static enumeration. For example, in an Excel sheet.

Parameters:

included - Set to true if you want to include static enumeration.

Since:

4.4.0

addUnsupportedDataTypes

public EBXSourceTableSpec.EBXSourceTableSpecBuilder addUnsupportedDataTypes(DataType... dataTypes)

Adds unsupported data types.

Parameters:

dataTypes - The unsupported data types.