com.incorta.connector.model

Class ConnectorModel.Builder

java.lang.Object

com.incorta.connector.model.ConnectorModel.Builder

Enclosing class:

ConnectorModel

public static class ConnectorModel.Builder
extends java.lang.Object

Builder is used for constructing a ConnectorModel instance.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
ConnectorModel.Builder	active(boolean active) Sets a boolean flag indicating whether or not this is an active connector.
ConnectorModel.Builder	addConnectorProperty(PropertyModel property) Adds a connector property that is displayed in the UI when user is creating or editing a connector.
ConnectorModel.Builder	addDataSetProperty(PropertyModel property) Adds a data set property that are displayed in the UI when user is creating or editing a table data set.
ConnectorModel	build() Creates and returns a ConnectorModel instance based on the specified values.
ConnectorModel.Builder	connectorProperties(java.util.List<PropertyModel> properties) Sets the list of connector properties that are displayed in the UI when user is creating or editing a connector.
ConnectorModel.Builder	dataSetProperties(java.util.List<PropertyModel> properties) Sets the list of data set properties that are displayed in the UI when user is creating or editing a table data set.
ConnectorModel.Builder	defaultConnectorName(java.lang.String defaultConnectorName) Sets the default connector name, which is used in case of predefined connector.
ConnectorModel.Builder	displaySourceFormat(java.lang.String displaySourceFormat) Sets the template for the text that is displayed below each data set in the UI.
ConnectorModel.Builder	iconBytes(byte[] iconBytes) Sets the icon that must be displayed for this connector type.
ConnectorModel.Builder	incrementalOnly(boolean incrementalOnly) Sets a boolean flag indicating whether or not this connector is incremental only.
ConnectorModel.Builder	predefined(boolean predefined) Sets a boolean flag indicating whether or not this is a predefined connector.
ConnectorModel.Builder	subTypeLabel(java.lang.String subTypeLabel) Sets the connector sub-type label which is displayed in the UI.
ConnectorModel.Builder	subTypeName(java.lang.String subTypeName) Sets the connector sub-type name.
ConnectorModel.Builder	typeLabel(java.lang.String typeLabel) Sets the connector type label which is displayed in the UI.
ConnectorModel.Builder	typeName(java.lang.String typeName) Sets the connector type name.
ConnectorModel.Builder	version(int version) Sets the connector version number.

Methods inherited from class java.lang.Object

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

Method Detail

typeName

public ConnectorModel.Builder typeName(java.lang.String typeName)

Sets the connector type name.

Parameters:

typeName -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

typeLabel

public ConnectorModel.Builder typeLabel(java.lang.String typeLabel)

Sets the connector type label which is displayed in the UI.

Parameters:

typeLabel -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

subTypeName

public ConnectorModel.Builder subTypeName(java.lang.String subTypeName)

Sets the connector sub-type name.

Parameters:

subTypeName -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

subTypeLabel

public ConnectorModel.Builder subTypeLabel(java.lang.String subTypeLabel)

Sets the connector sub-type label which is displayed in the UI.

Parameters:

subTypeLabel -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

version

public ConnectorModel.Builder version(int version)

Sets the connector version number.

Parameters:

version -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

defaultConnectorName

public ConnectorModel.Builder defaultConnectorName(java.lang.String defaultConnectorName)

Sets the default connector name, which is used in case of predefined connector.

Parameters:

defaultConnectorName -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

displaySourceFormat

public ConnectorModel.Builder displaySourceFormat(java.lang.String displaySourceFormat)

Sets the template for the text that is displayed below each data set in the UI. The template uses ${property} expressions to substitute referenced property names with their values at runtime. Also, a ${connector} expression can be used to display the name of the connector. Default display source format is "${connector"}.

Parameters:

displaySourceFormat -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

incrementalOnly

public ConnectorModel.Builder incrementalOnly(boolean incrementalOnly)

Sets a boolean flag indicating whether or not this connector is incremental only. An incremental only connector will only perform incremental extraction, even in a full-load job.

Parameters:

incrementalOnly -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

active

public ConnectorModel.Builder active(boolean active)

Sets a boolean flag indicating whether or not this is an active connector. Active connectors are always initialized right after creation or during server startup, as opposed to non-active connectors which are initialized which are initialized on first use.

Parameters:

active -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

predefined

public ConnectorModel.Builder predefined(boolean predefined)

Sets a boolean flag indicating whether or not this is a predefined connector. A predefined connector has a single predefined instance, the name of which is determined by ${code defaultConnectorName}. User cannot create more than one instance of a predefined connector. An example of predefined connectors is the LocalFiles connector.

Parameters:

predefined -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

connectorProperties

public ConnectorModel.Builder connectorProperties(java.util.List<PropertyModel> properties)

Sets the list of connector properties that are displayed in the UI when user is creating or editing a connector.

Parameters:

properties -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

addConnectorProperty

public ConnectorModel.Builder addConnectorProperty(PropertyModel property)

Adds a connector property that is displayed in the UI when user is creating or editing a connector.

Parameters:

property -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

dataSetProperties

public ConnectorModel.Builder dataSetProperties(java.util.List<PropertyModel> properties)

Sets the list of data set properties that are displayed in the UI when user is creating or editing a table data set.

Parameters:

properties -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

addDataSetProperty

public ConnectorModel.Builder addDataSetProperty(PropertyModel property)

Adds a data set property that are displayed in the UI when user is creating or editing a table data set.

Parameters:

property -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

iconBytes

public ConnectorModel.Builder iconBytes(byte[] iconBytes)

Sets the icon that must be displayed for this connector type.

Parameters:

iconBytes -

Returns:

ConnectorModel.Builder object for chaining

Since:

1.0

build

public ConnectorModel build()

Creates and returns a ConnectorModel instance based on the specified values.

Returns:

ConnectorModel instance

Since:

1.0