public class KeyValueConnector extends BaseDataSetConnector implements DataSetConnector<KeyValueConnectorParams,ConnectorResult>, StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>
DEFAULT_IMPORT
APP, COMMAND, ETL_DRIVER, FORMATTER, IDE_NODE, NO_RANK, WIDGET
Constructor and Description |
---|
KeyValueConnector() |
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.
|
addValue, basePostPersist, getCommitPolicy, getExt, getInputStream, getIoProcessor, getLicensePropertyName, getReader, getType, postPersistWhenEmpty, setCommitPolicy, stream, supportsWorksheets, testConnection
compareTo, getConfigFileName, getExtensionRank, getIconPath, getLocalUnitClassPath
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getExt, supportsReordering, supportsWorksheets, testConnection
getCommitPolicy, setCommitPolicy
public boolean canRead()
DataSetConnector
canRead
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public boolean canWrite()
DataSetConnector
canWrite
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public void cleanUp(KeyValueConnectorParams params, DataSet dataSet, Driver driver) throws Exception
DataSetConnector
cleanUp
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
params
- the DataSetConnectorParamsdataSet
- the data setdriver
- the driverException
- in case of any errorpublic KeyValueConnectorParams getDataSetConnectorParams()
DataSetConnector
getDataSetConnectorParams
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public String getDisplayName()
ExtensionModule
getDisplayName
in interface ExtensionModule
public String getName()
DataSetConnector
getName
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public String getVendor()
ExtensionModule
getVendor
in interface ExtensionModule
public String getVersion()
ExtensionModule
getVersion
in interface ExtensionModule
public String getXmlConfigFileName()
ExtensionModule
getXmlConfigFileName
in interface ExtensionModule
getXmlConfigFileName
in class BaseExtension
public void inlinePersist(KeyValueConnectorParams params, DataSet dataSet, Driver driver, DataSetRecord record, int row, int records) throws Exception
DataSetConnector
inlinePersist
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
params
- the DataSetConnectorParamsdataSet
- the data setdriver
- the driverrecord
- the recordrow
- the rowrecords
- the total number of recordsException
- in case of any errorpublic boolean isFileConnector()
DataSetConnector
isFileConnector
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public boolean isTextFormat()
DataSetConnector
isTextFormat
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public ConnectorResult persist(KeyValueConnectorParams params, DataSet dataSet, Driver driver) throws Exception
DataSetConnector
persist
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
params
- the DataSetConnectorParamsdataSet
- the data setdriver
- the driverException
- in case of any errorpublic boolean consume(KeyValueStreamingPackage streamingPackage, Object message, AtomicInteger row) throws Exception
StreamingConnector
consume
in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>
streamingPackage
- the streaming packagemessage
- the message to consumerow
- the current row numberException
- in case of any errorpublic void beforeStream(KeyValueProducerPackage producerPackage) throws Exception
StreamingConnector
beforeStream
in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>
producerPackage
- the producer packageException
- in case of any errorpublic void startStream(KeyValueProducerPackage producerPackage) throws Exception
StreamingConnector
startStream
in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>
producerPackage
- the producer packageException
- the exceptionpublic void endStream(KeyValueProducerPackage producerPackage) throws Exception
StreamingConnector
endStream
in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>
producerPackage
- the producer packageException
- in case of any errorpublic void closeStream(KeyValueStreamingPackage streamingPackage)
StreamingConnector
closeStream
in interface StreamingConnector<KeyValueStreamingPackage,KeyValueProducerPackage>
streamingPackage
- the streaming packagepublic ConnectorResult populate(KeyValueConnectorParams params, DataSet dataSet, Driver driver) throws Exception
DataSetConnector
populate
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
params
- the DataSetConnectorParamsdataSet
- the data setdriver
- the driverException
- in case of any errorpublic void postPersist(KeyValueConnectorParams params, DataSet dataSet, Driver driver) throws Exception
DataSetConnector
postPersist
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
params
- the DataSetConnectorParamsdataSet
- the data setdriver
- the driverException
- in case of any errorpublic void prePersist(KeyValueConnectorParams params, DataSet dataSet, Driver driver) throws Exception
DataSetConnector
prePersist
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
params
- the DataSetConnectorParamsdataSet
- the data setdriver
- the driverException
- in case of any errorpublic ConnectorResult writeMetaData(KeyValueConnectorParams params, DataSet dataSet, Driver driver) throws Exception
DataSetConnector
writeMetaData
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
params
- the DataSetConnectorParamsdataSet
- the data setdriver
- the driverException
- in case of any errorpublic String initQueryLabel()
DataSetConnector
initQueryLabel
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public boolean supportsReadStreaming()
DataSetConnector
supportsReadStreaming
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public boolean supportsWriteStreaming()
DataSetConnector
supportsWriteStreaming
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
public boolean supportsNested()
DataSetConnector
supportsNested
in interface DataSetConnector<KeyValueConnectorParams,ConnectorResult>
Copyright © 2010-2020 Toolsverse. All Rights Reserved.