com.toolsverse.etl.connector

Interface DataSetConnector<P extends DataSetConnectorParams,R extends ConnectorResult>

Type Parameters:

P - the generic DataSetConnectorParams type

R - the generic ConnectorResult type

All Superinterfaces:

Serializable

All Known Implementing Classes:

ApiJsonConnector, ClobConnector, ExcelConnector, ExcelXlsxConnector, HtmlConnector, JsonConnector, JsonDatasetConnector, KeyValueConnector, PdfConnector, SourceConnector, SqlConnector, TextConnector, XmlConnector, XmlObjectConnector, XmlObjectStreamingConnector

public interface DataSetConnector<P extends DataSetConnectorParams,R extends ConnectorResult>
extends Serializable

The class which populates and persists DataSet must implement DataSetConnector interface. Examples: TextConnector, XmlConnector, SqlConnector, etc.

Since:

2.0

Version:

2.0

See Also:

DataSetConnectorParams

Method Summary

Modifier and Type	Method and Description
boolean	canRead() Checks if connector can read data.
boolean	canWrite() Checks if connector can write data.
void	cleanUp(P params, DataSet dataSet, Driver driver) Cleans up after DataSetConnector populated or persisted DataSet.
P	getDataSetConnectorParams() Gets the DataSetConnectorParams.
String	getExt() Gets the file ext.
String	getName() Gets the name.
String	initQueryLabel() The init query label.
void	inlinePersist(P params, DataSet dataSet, Driver driver, DataSetRecord record, int row, int records) Persists data set row.
boolean	isFileConnector() Checks if this is a connector to the file based data source.
boolean	isTextFormat() Checks if this is a connector for the text-based data format, such as JOSN, XML, etc.
ConnectorResult	persist(P params, DataSet dataSet, Driver driver) Persists data set.
ConnectorResult	populate(P params, DataSet dataSet, Driver driver) Populates data set.
void	postPersist(P params, DataSet dataSet, Driver driver) Called when DataSetConnector finished persisting data set.
void	prePersist(P params, DataSet dataSet, Driver driver) Called when DataSetConnector starts persisting data set.
boolean	supportsNested() Supports nested.
boolean	supportsReadStreaming() Supports read streaming.
default boolean	supportsReordering(P params) Supports reordering of the fields.
boolean	supportsWorksheets() Checks if connector supports worksheets.
boolean	supportsWriteStreaming() Supports write streaming.
String	testConnection(ConnectionParams connectionParams) Tests the connection.
ConnectorResult	writeMetaData(P params, DataSet dataSet, Driver driver) Writes meta data.

Method Detail

supportsReadStreaming

boolean supportsReadStreaming()

Supports read streaming.

Returns:

true, if successful

supportsWriteStreaming

boolean supportsWriteStreaming()

Supports write streaming.

Returns:

true, if successful

supportsNested

boolean supportsNested()

Supports nested.

Returns:

true, if connector supports nested data sets

canRead

boolean canRead()

Checks if connector can read data.

Returns:

true, if connector can read data

canWrite

boolean canWrite()

Checks if connector can write data.

Returns:

true, if connector can write data

cleanUp

void cleanUp(P params,
             DataSet dataSet,
             Driver driver)
      throws Exception

Cleans up after DataSetConnector populated or persisted DataSet. Called regardless of exception. Usually used to free allocated resources such as streams, handlers, etc.

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Throws:

Exception - in case of any error

getDataSetConnectorParams

P getDataSetConnectorParams()

Gets the DataSetConnectorParams.

Returns:

the DataSetConnectorParams

getExt

String getExt()

Gets the file ext.

Returns:

the file ext

getName

String getName()

Gets the name.

Returns:

the name

inlinePersist

void inlinePersist(P params,
                   DataSet dataSet,
                   Driver driver,
                   DataSetRecord record,
                   int row,
                   int records)
            throws Exception

Persists data set row. For example adds line to the text file.

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

record - the record

row - the row

records - the total number of records

Throws:

Exception - in case of any error

isFileConnector

boolean isFileConnector()

Checks if this is a connector to the file based data source.

Returns:

true, if this is a connector to the file based data source.

isTextFormat

boolean isTextFormat()

Checks if this is a connector for the text-based data format, such as JOSN, XML, etc.

Returns:

true, if this is a connector for the text-based data format.

persist

ConnectorResult persist(P params,
                        DataSet dataSet,
                        Driver driver)
                 throws Exception

Persists data set.

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Returns:

the ConnectorResult

Throws:

Exception - in case of any error

populate

ConnectorResult populate(P params,
                         DataSet dataSet,
                         Driver driver)
                  throws Exception

Populates data set.

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Returns:

the ConnectorResult

Throws:

Exception - in case of any error

postPersist

void postPersist(P params,
                 DataSet dataSet,
                 Driver driver)
          throws Exception

Called when DataSetConnector finished persisting data set. Never called if there was an exception.

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Throws:

Exception - in case of any error

prePersist

void prePersist(P params,
                DataSet dataSet,
                Driver driver)
         throws Exception

Called when DataSetConnector starts persisting data set.

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Throws:

Exception - in case of any error

testConnection

String testConnection(ConnectionParams connectionParams)
               throws Exception

Tests the connection.

Parameters:

connectionParams - the connection params

Returns:

the status. If null or empty connection is ok

Throws:

Exception - the exception in case of any error

writeMetaData

ConnectorResult writeMetaData(P params,
                              DataSet dataSet,
                              Driver driver)
                       throws Exception

Writes meta data. For example along with delimited text file the DataSetConnector can create a xml file with the same name which contains field definitions.

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Returns:

the ConnectorResult

Throws:

Exception - in case of any error

initQueryLabel

String initQueryLabel()

The init query label. If not empty the init query, for example XML XQuery, will be enabled and label in editor will be set to the value of this field

Returns:

the string

supportsWorksheets

boolean supportsWorksheets()

Checks if connector supports worksheets.

Returns:

true, if connector supports worksheets

supportsReordering

default boolean supportsReordering(P params)

Supports reordering of the fields.

Parameters:

params - the params

Returns:

true, if connector supports reordering of the fields