com.incorta.connector.model

Class ConnectorModel

java.lang.Object

com.incorta.connector.model.ConnectorModel

All Implemented Interfaces:

java.io.Serializable

public class ConnectorModel
extends java.lang.Object
implements java.io.Serializable

A connector model is used by Incorta to determine how the connector behaves and how it should appear in the user interface. For example: what are the connector properties? What are the data set properties? What is the icon that should be used for this connector? ConnectorModel objects are immutable.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectorModel.Builder Builder is used for constructing a ConnectorModel instance.
static interface	ConnectorModel.ConnectorModelSource ConnectorModelSource interface is used to allow registered connectors to be accessed by calling ConnectorModel.getConnectorModel(...), while decoupling the ConnectorModel from the connector registry.

Method Summary

Modifier and Type	Method and Description
static ConnectorModel.Builder	builder() Creates a new blank ConnectorModel.Builder object used for constructing a ConnectorModel instance.
static ConnectorModel.Builder	builder(ConnectorModel template) Creates a new ConnectorModel.Builder object, initialized with the values from the specified ConnectorModel object.
static ConnectorModel	getConnectorModel(ConnectorFactoryContext context, java.lang.String type, java.lang.String subType, int version) Returns a registered connector model.
static ConnectorModel.ConnectorModelSource	getConnectorModelSource() Returns the connector registry object used to access registered connectors.
java.util.List<PropertyModel>	getConnectorProperties() Returns the list of connector properties that are displayed in the UI when user is creating or editing a connector.
java.util.List<PropertyModel>	getDataSetProperties() Returns the list of data set properties that are displayed in the UI when user is creating or editing a table data set.
java.lang.String	getDefaultConnectorName() Returns the default connector name, which is used in case of predefined connector.
java.lang.String	getDisplaySourceFormat() Returns the template for the text that is displayed below each data set in the UI.
byte[]	getIconBytes() Returns the icon that must be displayed for this connector type.
java.lang.String	getSubTypeLabel() Returns the connector sub-type label which is displayed in the UI.
java.lang.String	getSubTypeName() Returns the connector sub-type name.
java.lang.String	getTypeLabel() Returns the connector type label which is displayed in the UI.
java.lang.String	getTypeName() Returns the connector type name.
int	getVersion() Returns the connector version number.
boolean	isActive() Returns a boolean flag indicating whether or not this is an active connector.
boolean	isIncrementalOnly() Returns a boolean flag indicating whether or not this connector is incremental only.
boolean	isPredefined() Returns a boolean flag indicating whether or not this is a predefined connector.
static ConnectorModel.Builder	newModel(java.lang.String typeName, java.lang.String subTypeName) Creates a new ConnectorModel.Builder object used for constructing a ConnectorModel instance.
static ConnectorModel.Builder	newModel(java.lang.String typeName, java.lang.String typeLabel, java.lang.String subTypeName, java.lang.String subTypeLabel) Creates a new ConnectorModel.Builder object used for constructing a ConnectorModel instance.
static PropertyModel.Builder	newProperty(java.lang.String name) Creates a new PropertyModel.Builder object used for constructing a PropertyModel instance.
static PropertyModel.Builder	newProperty(java.lang.String name, java.lang.String label) Creates a new PropertyModel.Builder object used for constructing a PropertyModel instance.
static void	setConnectorModelSource(ConnectorModel.ConnectorModelSource connectorModelSource) Sets the connector registry object that can be used to access registered connectors by calling ConnectorModel.getConnectorModel(...)

Methods inherited from class java.lang.Object

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

Method Detail

getConnectorModelSource

public static ConnectorModel.ConnectorModelSource getConnectorModelSource()

Returns the connector registry object used to access registered connectors.

Returns:

ConnectorModel.ConnectorModelSource object

Since:

1.0

setConnectorModelSource

public static void setConnectorModelSource(ConnectorModel.ConnectorModelSource connectorModelSource)

Sets the connector registry object that can be used to access registered connectors by calling ConnectorModel.getConnectorModel(...)

Parameters:

connectorModelSource -

Since:

1.0

getConnectorModel

public static ConnectorModel getConnectorModel(ConnectorFactoryContext context,
                                               java.lang.String type,
                                               java.lang.String subType,
                                               int version)

Returns a registered connector model. Note that a connector registry object must be set by calling ConnectorModel.setConnectorModelSource(...)

Parameters:

context -

type - Connector type name

subType - Connector sub-type name

version - Connector version

Returns:

ConnectorModel object, null if not found

Since:

1.0

getTypeName

public java.lang.String getTypeName()

Returns the connector type name.

Returns:

Connector type name

Since:

1.0

getTypeLabel

public java.lang.String getTypeLabel()

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

Returns:

Connector type label

Since:

1.0

getSubTypeName

public java.lang.String getSubTypeName()

Returns the connector sub-type name.

Returns:

Connector sub-type name

Since:

1.0

getSubTypeLabel

public java.lang.String getSubTypeLabel()

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

Returns:

Connector sub-type label

Since:

1.0

getVersion

public int getVersion()

Returns the connector version number.

Returns:

Connector version

Since:

1.0

getDefaultConnectorName

public java.lang.String getDefaultConnectorName()

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

Returns:

Default connector name

Since:

1.0

getDisplaySourceFormat

public java.lang.String getDisplaySourceFormat()

Returns 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"}.

Returns:

Display source format

Since:

1.0

isIncrementalOnly

public boolean isIncrementalOnly()

Returns 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.

Returns:

true if incremental only, false otherwise

Since:

1.0

isActive

public boolean isActive()

Returns 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.

Returns:

true if active, false otherwise

Since:

1.0

isPredefined

public boolean isPredefined()

Returns 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.

Returns:

true if predefined, false otherwise

Since:

1.0

getConnectorProperties

public java.util.List<PropertyModel> getConnectorProperties()

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

Returns:

List of PropertyModel objects

Since:

1.0

getDataSetProperties

public java.util.List<PropertyModel> getDataSetProperties()

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

Returns:

List of PropertyModel objects

Since:

1.0

getIconBytes

public byte[] getIconBytes()

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

Returns:

Icon bytes

Since:

1.0

newModel

public static ConnectorModel.Builder newModel(java.lang.String typeName,
                                              java.lang.String typeLabel,
                                              java.lang.String subTypeName,
                                              java.lang.String subTypeLabel)

Creates a new ConnectorModel.Builder object used for constructing a ConnectorModel instance. Connector version is set to 1 by default.

Parameters:

typeName - Connector type name

typeLabel - Connector type label

subTypeName - Connector sub-type name

subTypeLabel - Connector sub-type label

Returns:

New ConnectorModel.Builder object

Since:

1.0

newModel

public static ConnectorModel.Builder newModel(java.lang.String typeName,
                                              java.lang.String subTypeName)

Creates a new ConnectorModel.Builder object used for constructing a ConnectorModel instance. Type label is set to typeName. Sub-type label is set to subTypeName. Connector version is set to 1 by default.

Parameters:

typeName - Connector type name

subTypeName - Connector sub-type name

Returns:

New ConnectorModel.Builder object

Since:

1.0

newProperty

public static PropertyModel.Builder newProperty(java.lang.String name,
                                                java.lang.String label)

Creates a new PropertyModel.Builder object used for constructing a PropertyModel instance.

Parameters:

name - Property name

label - Property label

Returns:

New PropertyModel.Builder object

Since:

1.0

newProperty

public static PropertyModel.Builder newProperty(java.lang.String name)

Creates a new PropertyModel.Builder object used for constructing a PropertyModel instance. Property label is set to name.

Parameters:

name - Property name

label - Property label

Returns:

New PropertyModel.Builder object

Since:

1.0

builder

public static ConnectorModel.Builder builder()

Creates a new blank ConnectorModel.Builder object used for constructing a ConnectorModel instance.

Returns:

New ConnectorModel.Builder object

Since:

1.0

builder

public static ConnectorModel.Builder builder(ConnectorModel template)

Creates a new ConnectorModel.Builder object, initialized with the values from the specified ConnectorModel object.

Parameters:

template - ConnectorModel instance used for initializing this builder

Returns:

New ConnectorModel.Builder object

Since:

1.0