public abstract class DataSetConnectorParams
extends Object
implements Serializable
DataSetConnector
to store parameters
needed to persist and populate data set. The particular class implementing
DataSetConnectorParams may include, for example, file name or database
connection.Modifier and Type | Field and Description |
---|---|
static String |
AUTO_COMMIT_PROP |
static String |
FILE_NAME_PROP
The FILE NAME property.
|
static String |
MAX_ROWS_EXCEEDED_EXCEPTION
The MAX ROWS EXCEEDED EXCEPTION message.
|
static String |
PASSWORD_PROP
PASSWORD property.
|
static String |
PROPERTIES_PROP
PROPERTIES property.
|
static String |
TRANSPORT_PROP
TRANSPORT property.
|
static String |
USE_SELECTED_PROP
The USE SELECTED property.
|
static String |
USER_ID_PROP
The USER ID property.
|
Constructor and Description |
---|
DataSetConnectorParams()
Instantiates a new DataSetConnectorParams.
|
Modifier and Type | Method and Description |
---|---|
abstract Alias |
alias2alias(Alias source)
Creates an new Alias object using given source alias.
|
abstract DataSetConnectorParams |
copy()
Create a copy of this object.
|
AddFieldValueCallback |
getAddFieldValueCallback()
Gets the AddFieldValueCallback object.
|
AddRecordCallback |
getAddRecordCallback()
Gets the AddRecordCallback object.
|
AfterCallback |
getAfterCallback()
Gets the AfterCallback object.
|
BeforeCallback |
getBeforeCallback()
Gets the BeforeCallback object.
|
CacheProvider<String,Object> |
getCacheProvider()
Gets the cache provider.
|
String |
getCrudAction()
Gets the crud action.
|
abstract String |
getInitStr(String name,
Alias alias)
Gets the initialization string using given alias.
|
InputStream |
getInputStream()
Gets the input stream.
|
IoProcessor |
getIoProcessor()
Gets the io processor.
|
int |
getLogStep()
Gets the log step.
|
int |
getMaxRows()
Gets the maximum number of rows allowed for the DataSet.
|
OutputStream |
getOutputStream()
Gets the output stream.
|
Map<String,String> |
getParams()
Gets the parameters.
|
abstract String |
getPropsHint()
Gets the hint displayed next to the properties editor.
|
abstract String |
getPropsWizardResource(Driver driver,
String connectionDriver)
Gets the name of the xml file used to create a wizard for editing
properties.
|
ReadTracker |
getReadTracker()
Gets the read tracker.
|
String |
getTarget()
Gets the target.
|
TransactionMonitor |
getTransactionMonitor()
Gets the transaction monitor.
|
boolean |
hasAddRecordCallback()
Checks if extractor has add record callback.
|
abstract void |
init(Alias alias)
Initializes itself using given alias.
|
abstract void |
init(Map<String,String> props)
Initializes itself using given properties.
|
abstract void |
init(ObjectStorage storage)
Initializes itself using given object storage.
|
boolean |
isCleanUpPersistOccured()
Checks if DataSetConnector#cleanUp method has been already called.
|
boolean |
isCloseInput()
Checks if input stream needs to be closed.
|
boolean |
isCloseOutput()
Checks if output stream needs to be closed.
|
boolean |
isEnabled()
Checks if writing and reading enabled.
|
boolean |
isIgnoreEmpty()
If true, the source without dataset, for example, when file does not
exist, will be ignored.
|
boolean |
isIgnoreNoRecords()
If true, the source without without records will be ignored.
|
boolean |
isMaxRowsExceededException(Exception ex)
Checks if is "max rows exceeded" exception has occurred.
|
boolean |
isPostPersistOccured()
Checks if DataSetConnector#postPersist has been already called.
|
boolean |
isPrePersistOccured()
Checks if DataSetConnector#prePersist has been already called.
|
boolean |
isReadOnlyMetadata()
If true read only metadata and skip data.
|
boolean |
isSilent()
Checks if "is silent" flag set.
|
boolean |
isStreaming()
Checks if is streaming.
|
void |
prepareForPopulate()
This is called from UI when connection parameters need to be prepared to
be used by to pipulate a data set .
|
void |
setAddFieldValueCallback(AddFieldValueCallback value)
Sets the AddFieldValueCallback object.
|
void |
setAddRecordCallback(AddRecordCallback value)
Sets the AddRecordCallback object.
|
void |
setAfterCallback(AfterCallback value)
Sets the AfterCallback object.
|
void |
setBeforeCallback(BeforeCallback value)
Sets the AfterCallback object.
|
void |
setCacheProvider(CacheProvider<String,Object> value)
Sets the cache provider.
|
void |
setCleanUpPersistOccurred(boolean value)
Sets the flag "clean up has occurred".
|
void |
setCloseInput(boolean value)
Sets the flag "close input stream".
|
void |
setCloseOutput(boolean value)
Sets the flag "close output stream".
|
void |
setCrudAction(String crudAction)
Sets the crud action.
|
void |
setEnabled(boolean value)
Sets the "is enabled" flag.
|
void |
setHasAddRecordCallback(boolean hasAddRecordCallback)
Sets the flag "has add record callback".
|
void |
setIgnoreEmpty(boolean value)
Sets the ignore empty flag.
|
void |
setIgnoreNoRecords(boolean value)
Sets the ignore no records flag.
|
void |
setInputStream(InputStream value)
Sets the input stream.
|
void |
setIoProcessor(IoProcessor ioProcessor)
Sets the io processor.
|
void |
setLogStep(int value)
Sets the log step.
|
void |
setMaxRows(int value)
Sets the maximum number of rows allowed for the DataSet.
|
void |
setOutputStream(OutputStream value)
Sets the output stream.
|
void |
setPostPersistOccured(boolean value)
Sets the flag "post persist has occurred".
|
void |
setPrePersistOccured(boolean value)
Sets the flag "pre persist has occurred".
|
void |
setReadOnlyMetadata(boolean readOnlyMetadata)
Sets the value of the flag "read only metadata".
|
void |
setReadTracker(ReadTracker readTracker)
Sets the read tracker.
|
void |
setSilent(boolean value)
Sets the "is silent" flag.
|
void |
setTarget(String target)
Sets the target.
|
void |
setTransactionMonitor(TransactionMonitor value)
Sets the transaction monitor.
|
void |
setUseSelectedDataSet(boolean value)
Sets the "use selected data set" flag.
|
boolean |
useSelectedDataSet()
Checks if "use selected data set" flag is set.
|
public static final String AUTO_COMMIT_PROP
public static final String FILE_NAME_PROP
public static final String USER_ID_PROP
public static final String PASSWORD_PROP
public static final String PROPERTIES_PROP
public static final String TRANSPORT_PROP
public static final String USE_SELECTED_PROP
public static final String MAX_ROWS_EXCEEDED_EXCEPTION
public DataSetConnectorParams()
public abstract Alias alias2alias(Alias source) throws Exception
source
- the source aliasException
- in case of any errorpublic abstract DataSetConnectorParams copy()
public AddFieldValueCallback getAddFieldValueCallback()
public AddRecordCallback getAddRecordCallback()
public AfterCallback getAfterCallback()
public BeforeCallback getBeforeCallback()
public CacheProvider<String,Object> getCacheProvider()
public abstract String getInitStr(String name, Alias alias)
name
- the namealias
- the aliaspublic InputStream getInputStream()
public IoProcessor getIoProcessor()
public int getLogStep()
public int getMaxRows()
public OutputStream getOutputStream()
public Map<String,String> getParams()
public abstract String getPropsHint()
public abstract String getPropsWizardResource(Driver driver, String connectionDriver)
driver
- the ETL driverconnectionDriver
- the connection driverpublic TransactionMonitor getTransactionMonitor()
public abstract void init(Alias alias)
alias
- the aliaspublic abstract void init(Map<String,String> props)
props
- the propertiespublic abstract void init(ObjectStorage storage)
storage
- the object storagepublic boolean isCleanUpPersistOccured()
public boolean isCloseInput()
public boolean isCloseOutput()
public boolean isEnabled()
public boolean isMaxRowsExceededException(Exception ex)
ex
- the exceptionpublic boolean isPostPersistOccured()
public boolean isPrePersistOccured()
public boolean isSilent()
public void prepareForPopulate()
public void setAddFieldValueCallback(AddFieldValueCallback value)
value
- the new AddFieldValueCallback objectpublic void setAddRecordCallback(AddRecordCallback value)
value
- the new AddRecordCallback objectpublic void setAfterCallback(AfterCallback value)
value
- the new AfterCallback objectpublic void setBeforeCallback(BeforeCallback value)
value
- the new AfterCallback objectpublic void setCacheProvider(CacheProvider<String,Object> value)
value
- the new cache providerpublic void setCleanUpPersistOccurred(boolean value)
value
- the new value for the flag "clean up has occurred"public void setCloseInput(boolean value)
value
- the new value for the flag "close input stream"public void setCloseOutput(boolean value)
value
- the new value for the flag "close output stream"public void setEnabled(boolean value)
value
- the new "is enabled" flagpublic void setInputStream(InputStream value)
value
- the new input streampublic void setIoProcessor(IoProcessor ioProcessor)
ioProcessor
- the new io processorpublic void setLogStep(int value)
value
- the new log steppublic void setMaxRows(int value)
value
- the new the maximum number of rows allowed for the DataSetpublic void setOutputStream(OutputStream value)
value
- the new output streampublic void setPostPersistOccured(boolean value)
value
- the new value for the flag "post persist has occurred"public void setPrePersistOccured(boolean value)
value
- the new value for the flag "pre persist has occurred"public void setSilent(boolean value)
value
- the new value for the "is silent" flagpublic void setTransactionMonitor(TransactionMonitor value)
value
- the new transaction monitorpublic void setUseSelectedDataSet(boolean value)
value
- the new value for the "use selected data set" flagpublic boolean useSelectedDataSet()
public boolean isIgnoreEmpty()
public void setIgnoreEmpty(boolean value)
value
- the new value for the ignore empty flagpublic boolean isIgnoreNoRecords()
public void setIgnoreNoRecords(boolean value)
value
- the new value for the ignore no records flagpublic ReadTracker getReadTracker()
public void setReadTracker(ReadTracker readTracker)
readTracker
- the new read trackerpublic boolean isStreaming()
public String getCrudAction()
public void setCrudAction(String crudAction)
crudAction
- the new crud actionpublic String getTarget()
public void setTarget(String target)
target
- the new targetpublic boolean isReadOnlyMetadata()
public void setReadOnlyMetadata(boolean readOnlyMetadata)
readOnlyMetadata
- boolean the new value of the "read only metadata" flagpublic boolean hasAddRecordCallback()
public void setHasAddRecordCallback(boolean hasAddRecordCallback)
hasAddRecordCallback
- booleanCopyright © 2010-2020 Toolsverse. All Rights Reserved.