com.toolsverse.etl.connector

Class BaseDataSetConnector

Object

com.toolsverse.ext.BaseExtension

com.toolsverse.etl.connector.BaseDataSetConnector

All Implemented Interfaces:

ExtensionModule, Serializable, Comparable<ExtensionModule>

Direct Known Subclasses:

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

public abstract class BaseDataSetConnector
extends BaseExtension

The base class for all DataSetConnectors.

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_IMPORT The 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
BaseDataSetConnector()

Method Summary

Modifier and Type	Method and Description
void	addValue(Object colValue, DataSetRecord record, DataSet dataSet) Adds value to the current field of the current record.
void	basePostPersist(DataSetConnectorParams params, DataSet dataSet, Driver driver) Executed when persisting is done.
StreamingCommitPolicy	getCommitPolicy() Gets the commit policy.
String	getExt() Gets the file ext.
InputStream	getInputStream(File dataFile, InputStream inputStream, String preProcessor) Gets the input stream.
IoProcessor	getIoProcessor(Alias alias, Driver driver) Gets the io processor.
String	getLicensePropertyName() Gets the name of the license property.
BufferedReader	getReader(File dataFile, InputStream inputStream, String encoding, String preProcessor, DataSetConnectorParams params) Gets the reader.
String	getType() Gets the type of the extension module.
void	postPersistWhenEmpty(DataSetConnectorParams params) Called when DataSetConnector finished persisting data set with no records.
void	setCommitPolicy(StreamingCommitPolicy commitPolicy) Sets the commit policy.
ConnectorResult	stream(StreamingPackage streamingPackage, Alias alias, StreamingConnector connector) Stream data.
boolean	supportsWorksheets()
String	testConnection(ConnectionParams connectionParams) Test connection.

Methods inherited from class com.toolsverse.ext.BaseExtension

compareTo, getConfigFileName, getExtensionRank, getIconPath, getLocalUnitClassPath, getXmlConfigFileName

Methods inherited from class Object

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

Methods inherited from interface com.toolsverse.ext.ExtensionModule

getDisplayName, getVendor, getVersion

Field Detail

DEFAULT_IMPORT

public static final String DEFAULT_IMPORT

The DEFAULT IMPORT.

See Also:

Constant Field Values

Constructor Detail

BaseDataSetConnector

public BaseDataSetConnector()

Method Detail

addValue

public void addValue(Object colValue,
                     DataSetRecord record,
                     DataSet dataSet)

Adds value to the current field of the current record.

Parameters:

colValue - the value

record - the record

dataSet - the data set

basePostPersist

public void basePostPersist(DataSetConnectorParams params,
                            DataSet dataSet,
                            Driver driver)
                     throws Exception

Executed when persisting is done.

Parameters:

params - the parameters

dataSet - the data set

driver - the driver

Throws:

Exception - in case of any error

postPersistWhenEmpty

public void postPersistWhenEmpty(DataSetConnectorParams params)

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

Parameters:

params - the params

getExt

public String getExt()

Gets the file ext.

Returns:

the file ext

getLicensePropertyName

public String getLicensePropertyName()

Description copied from interface: ExtensionModule

Gets the name of the license property. If not null the model is a subject of licensing.

Returns:

the name of the license property

getType

public String getType()

Description copied from interface: ExtensionModule

Gets the type of the extension module.

Returns:

the type

testConnection

public String testConnection(ConnectionParams connectionParams)
                      throws Exception

Test connection.

Parameters:

connectionParams - the connection params

Returns:

the string

Throws:

Exception - the exception

getReader

public BufferedReader getReader(File dataFile,
                                InputStream inputStream,
                                String encoding,
                                String preProcessor,
                                DataSetConnectorParams params)
                         throws Exception

Gets the reader.

Parameters:

dataFile - the data file

inputStream - the input stream

encoding - the encoding

preProcessor - the pre processor code

params - the parameters

Returns:

the reader

Throws:

Exception - in case of any error

getInputStream

public InputStream getInputStream(File dataFile,
                                  InputStream inputStream,
                                  String preProcessor)
                           throws Exception

Gets the input stream.

Parameters:

dataFile - the data file

inputStream - the input stream

preProcessor - the pre processor code

Returns:

the InputStream

Throws:

Exception - in case of any error

stream

public ConnectorResult stream(StreamingPackage streamingPackage,
                              Alias alias,
                              StreamingConnector connector)
                       throws Exception

Stream data.

Parameters:

streamingPackage - the streaming package

alias - the alias

connector - the connector

Returns:

the result

Throws:

Exception - in case of any error

getCommitPolicy

public StreamingCommitPolicy getCommitPolicy()

Gets the commit policy.

Returns:

the commit policy

setCommitPolicy

public void setCommitPolicy(StreamingCommitPolicy commitPolicy)

Sets the commit policy.

Parameters:

commitPolicy - the new commit policy

supportsWorksheets

public boolean supportsWorksheets()

getIoProcessor

public IoProcessor getIoProcessor(Alias alias,
                                  Driver driver)

Gets the io processor.

Parameters:

alias - the alias

driver - the driver

Returns:

the io processor