com.toolsverse.etl.connector.text

Class KeyValueConnector

Object

com.toolsverse.ext.BaseExtension

com.toolsverse.etl.connector.BaseDataSetConnector

com.toolsverse.etl.connector.text.KeyValueConnector

All Implemented Interfaces:

DataSetConnector<KeyValueConnectorParams,ConnectorResult>, ExtensionModule, StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>, Serializable, Comparable<ExtensionModule>

public class KeyValueConnector
extends BaseDataSetConnector
implements DataSetConnector<KeyValueConnectorParams,ConnectorResult>, StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>

Reads and writes key=value text files. Supports data streaming.

Since:

5.9

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.toolsverse.etl.connector.BaseDataSetConnector

DEFAULT_IMPORT

Fields inherited from interface com.toolsverse.ext.ExtensionModule

APP, COMMAND, ETL_DRIVER, FORMATTER, IDE_NODE, NO_RANK, WIDGET

Constructor Summary

Constructors

Constructor and Description
KeyValueConnector()

Method Summary

Modifier and Type	Method and Description
void	beforeStream(KeyValueProducerPackage producerPackage) Executed before record has been streamed.
boolean	canRead() Checks if connector can read data.
boolean	canWrite() Checks if connector can write data.
void	cleanUp(KeyValueConnectorParams params, DataSet dataSet, Driver driver) Cleans up after DataSetConnector populated or persisted DataSet.
void	closeStream(KeyValueStreamingPackage streamingPackage) Close stream.
boolean	consume(KeyValueStreamingPackage streamingPackage, Object message, AtomicInteger row) Consume the next record.
void	endStream(KeyValueProducerPackage producerPackage) Executed after record has been streamed.
KeyValueConnectorParams	getDataSetConnectorParams() Gets the DataSetConnectorParams.
String	getDisplayName() Gets the display name.
String	getName() Gets the name.
String	getVendor() Gets the vendor.
String	getVersion() Gets the version of the extension module.
String	getXmlConfigFileName() Gets the path to the xml configuration file for the module.
String	initQueryLabel() The init query label.
void	inlinePersist(KeyValueConnectorParams 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(KeyValueConnectorParams params, DataSet dataSet, Driver driver) Persists data set.
ConnectorResult	populate(KeyValueConnectorParams params, DataSet dataSet, Driver driver) Populates data set.
void	postPersist(KeyValueConnectorParams params, DataSet dataSet, Driver driver) Called when DataSetConnector finished persisting data set.
void	prePersist(KeyValueConnectorParams params, DataSet dataSet, Driver driver) Called when DataSetConnector starts persisting data set.
void	startStream(KeyValueProducerPackage producerPackage) Start the stream.
boolean	supportsNested() Supports nested.
boolean	supportsReadStreaming() Supports read streaming.
boolean	supportsWriteStreaming() Supports write streaming.
ConnectorResult	writeMetaData(KeyValueConnectorParams params, DataSet dataSet, Driver driver) Writes meta data.

Methods inherited from class com.toolsverse.etl.connector.BaseDataSetConnector

addValue, basePostPersist, getCommitPolicy, getExt, getInputStream, getIoProcessor, getLicensePropertyName, getReader, getType, postPersistWhenEmpty, setCommitPolicy, stream, supportsWorksheets, testConnection

Methods inherited from class com.toolsverse.ext.BaseExtension

compareTo, getConfigFileName, getExtensionRank, getIconPath, getLocalUnitClassPath

Methods inherited from class Object

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

Methods inherited from interface com.toolsverse.etl.connector.DataSetConnector

getExt, supportsReordering, supportsWorksheets, testConnection

Methods inherited from interface com.toolsverse.io.StreamingConnector

getCommitPolicy, setCommitPolicy

Constructor Detail

KeyValueConnector

public KeyValueConnector()

Method Detail

canRead

public boolean canRead()

Description copied from interface: DataSetConnector

Checks if connector can read data.

Specified by:

canRead in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

true, if connector can read data

canWrite

public boolean canWrite()

Description copied from interface: DataSetConnector

Checks if connector can write data.

Specified by:

canWrite in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

true, if connector can write data

cleanUp

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

Description copied from interface: DataSetConnector

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

Specified by:

cleanUp in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Throws:

Exception - in case of any error

getDataSetConnectorParams

public KeyValueConnectorParams getDataSetConnectorParams()

Description copied from interface: DataSetConnector

Gets the DataSetConnectorParams.

Specified by:

getDataSetConnectorParams in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

the DataSetConnectorParams

getDisplayName

public String getDisplayName()

Description copied from interface: ExtensionModule

Gets the display name. This name will be used to display module in the various UI controls.

Specified by:

getDisplayName in interface ExtensionModule

Returns:

the display name

getName

public String getName()

Description copied from interface: DataSetConnector

Gets the name.

Specified by:

getName in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

the name

getVendor

public String getVendor()

Description copied from interface: ExtensionModule

Gets the vendor.

Specified by:

getVendor in interface ExtensionModule

Returns:

the vendor

getVersion

public String getVersion()

Description copied from interface: ExtensionModule

Gets the version of the extension module.

Specified by:

getVersion in interface ExtensionModule

Returns:

the version

getXmlConfigFileName

public String getXmlConfigFileName()

Description copied from interface: ExtensionModule

Gets the path to the xml configuration file for the module. The xml configuration file usually contains module specific UI elements, resides inside package and deployed with the code in the jar file.

Specified by:

getXmlConfigFileName in interface ExtensionModule

Overrides:

getXmlConfigFileName in class BaseExtension

Returns:

the path to the configuration name

inlinePersist

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

Description copied from interface: DataSetConnector

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

Specified by:

inlinePersist in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

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

public boolean isFileConnector()

Description copied from interface: DataSetConnector

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

Specified by:

isFileConnector in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

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

isTextFormat

public boolean isTextFormat()

Description copied from interface: DataSetConnector

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

Specified by:

isTextFormat in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

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

persist

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

Description copied from interface: DataSetConnector

Persists data set.

Specified by:

persist in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Returns:

the ConnectorResult

Throws:

Exception - in case of any error

consume

public boolean consume(KeyValueStreamingPackage streamingPackage,
                       Object message,
                       AtomicInteger row)
                throws Exception

Description copied from interface: StreamingConnector

Consume the next record.

Specified by:

consume in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>

Parameters:

streamingPackage - the streaming package

message - the message to consume

row - the current row number

Returns:

true, if successful

Throws:

Exception - in case of any error

beforeStream

public void beforeStream(KeyValueProducerPackage producerPackage)
                  throws Exception

Description copied from interface: StreamingConnector

Executed before record has been streamed.

Specified by:

beforeStream in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>

Parameters:

producerPackage - the producer package

Throws:

Exception - in case of any error

startStream

public void startStream(KeyValueProducerPackage producerPackage)
                 throws Exception

Description copied from interface: StreamingConnector

Start the stream.

Specified by:

startStream in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>

Parameters:

producerPackage - the producer package

Throws:

Exception - the exception

endStream

public void endStream(KeyValueProducerPackage producerPackage)
               throws Exception

Description copied from interface: StreamingConnector

Executed after record has been streamed.

Specified by:

endStream in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>

Parameters:

producerPackage - the producer package

Throws:

Exception - in case of any error

closeStream

public void closeStream(KeyValueStreamingPackage streamingPackage)

Description copied from interface: StreamingConnector

Close stream.

Specified by:

closeStream in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>

Parameters:

streamingPackage - the streaming package

populate

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

Description copied from interface: DataSetConnector

Populates data set.

Specified by:

populate in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Returns:

the ConnectorResult

Throws:

Exception - in case of any error

postPersist

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

Description copied from interface: DataSetConnector

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

Specified by:

postPersist in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Throws:

Exception - in case of any error

prePersist

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

Description copied from interface: DataSetConnector

Called when DataSetConnector starts persisting data set.

Specified by:

prePersist in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Throws:

Exception - in case of any error

writeMetaData

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

Description copied from interface: DataSetConnector

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.

Specified by:

writeMetaData in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Parameters:

params - the DataSetConnectorParams

dataSet - the data set

driver - the driver

Returns:

the ConnectorResult

Throws:

Exception - in case of any error

initQueryLabel

public String initQueryLabel()

Description copied from interface: DataSetConnector

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

Specified by:

initQueryLabel in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

the string

supportsReadStreaming

public boolean supportsReadStreaming()

Description copied from interface: DataSetConnector

Supports read streaming.

Specified by:

supportsReadStreaming in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

true, if successful

supportsWriteStreaming

public boolean supportsWriteStreaming()

Description copied from interface: DataSetConnector

Supports write streaming.

Specified by:

supportsWriteStreaming in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

true, if successful

supportsNested

public boolean supportsNested()

Description copied from interface: DataSetConnector

Supports nested.

Specified by:

supportsNested in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>

Returns:

true, if connector supports nested data sets