Source (Toolsverse API Reference 5.9)

Object
- com.toolsverse.etl.common.ConditionalExecution
- - com.toolsverse.etl.common.OnException
  - - com.toolsverse.etl.core.engine.Source

All Implemented Interfaces:

ReadTracker, Block, LocationProvider, Serializable
```
public class Source
extends OnException
implements Block, ReadTracker
```
Source is a one of the two building blocks of the ETL scenario: etl process extracts data from the Sources and loads into the Destinations. It implements Block interface and adds some methods and members specific for the Source. There are can be multiple sources in the scenario. In some cases the code for the source can be executed in the separate thread.
Example of source declaration in the scenario file:

<source>

<name>image</name>

<extract>

<sql>select * from image</sql>

</extract>

</source>

Since:

1.0

Version:

2.0

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.toolsverse.etl.core.engine.Block
  Block.BlockType

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BEFORE_SQL_ATTR` BEFORE_SQL_ATTR.
`static String`	`COND_CONNECTION_ATTR` COND_CONNECTION_ATTR.
`static String`	`COND_lANG_ATTR` COND_lANG_ATTR.
`static String`	`CONDITION_ATTR` CONDITION_ATTR.
`static String`	`CONNECTION_ATTR` CONNECTION_ATTR.
`static String`	`EMPTY_ATTR` EMPTY_ATTR.
`static String`	`ENABLED_ATTR` ENABLED_ATTR.
`static String`	`ENCODE_ATTR` ENCODE_ATTR.
`static String`	`ETL_DRIVER_ATTR` ETL_DRIVER_ATTR.
`static String`	`EXCLUDE_ATTR` EXCLUDE_ATTR.
`static String`	`FETCH_SIZE_ATTR` FETCH_SIZE_ATTR.
`static String`	`IGNORE_EMPTY_ATTR` IGNORE_EMPTY_ATTR.
`static String`	`IGNORE_NO_RECORDS_ATTR` IGNORE_NO_RECORDS_ATTR.
`static String`	`INCLUDE_ATTR` INCLUCE_ATTR.
`static String`	`INDEPENDENT_ATTR` INDEPENDENT_ATTR.
`static String`	`KEY_FIELDS_ATTR` KEY_FIELDS_ATTR.
`static String`	`LIMIT_ATTR` LIMIT_ATTR.
`static String`	`LINKED_SOURCE_ATTR` LINKED_SOURCE_ATTR.
`static String`	`MANDATORY_ATTR` MANDATORY_ATTR.
`static String`	`MATCH_ATTR` MATCH_ATTR.
`static String`	`MAX_FILES_ATTR` MAX_FILS_ATTR.
`static String`	`METRICS_ENABLED_ATTR` The METRICS_ENABLED_ATTR.
`static String`	`NAME_ATTR` NAME_ATTR.
`static String`	`NEW_CONNECTION_ATTR` NEW_CONNECTION_ATTR.
`static String`	`NEW_CONNECTION_SOURCE_QUERY_ATTR` NEW_CONNECTION_SOURCE_QUERY_ATTR.
`static String`	`NO_CONNECTION_ATTR` NO_CONNECTION_ATTR.
`static String`	`OBJECT_NAME_ATTR` OBJECT_NAME_ATTR.
`static String`	`ON_EXCEPTION_ACTION_ATTR` ON_EXCEPTION_ACTION_ATTR.
`static String`	`ON_EXCEPTION_MASK_ATTR` ON_EXCEPTION_MASK_ATTR.
`static String`	`ON_PERSIST_ATTR` ON_PERSIST_ATTR.
`static String`	`ON_POPULATE_ATTR` ON_POPULATE_ATTR.
`static String`	`OWNER_ATTR` OWNER_ATTR.
`static String`	`PARALLEL_ATTR` PARALLEL_ATTR.
`static String`	`READER_ATTR` READER_ATTR.
`static String`	`SOURCE_ATTR` SOURCE_ATTR.
`static String`	`SOURCE_SQL_ATTR` SOURCE_SQL_ATTR.
`static String`	`SQL_ATTR` SQL_ATTR.
`static String`	`SQL_STATEMENT_OUTPUT_PARAM_INDEEX_ATTR` OUTPUT PARAMETERS INDEX ATTR.
`static String`	`SQL_STATEMENT_PARAM_INDEX_ATTR` OUTPUT PARAMETER INDEX FOR CALLABLE STATEMENT ATTR.
`static String`	`SQL_STATEMENT_TYPE_ATTR` EXTRACT SQL STATEMENT TYPE ATTR.
`static String`	`TRACKING_ENABLED_ATTR` The TRACKING_ENABLED_ATTR.
`static String`	`UPDATE_KEY_ATTR` UPDATE_KEY_ATTR.
`static String`	`USING_ATTR` USING_ATTR.
`static String`	`WILDCARD_PARALLEL_ATTR` WILDCARD_PARALLEL_ATTR.
`static String`	`WRITER_ATTR` WRITER_ATTR.

Fields inherited from class com.toolsverse.etl.common.OnException
ON_EXCEPTION, ON_EXCEPTION_CONTINUE, ON_EXCEPTION_CONTINUE_STR, ON_EXCEPTION_IGNORE, ON_EXCEPTION_IGNORE_STR, ON_EXCEPTION_MERGE, ON_EXCEPTION_MERGE_STR, ON_EXCEPTION_RAISE, ON_EXCEPTION_RAISE_KEY, ON_EXCEPTION_RAISE_STR, ON_EXCEPTION_TYPE, ON_PARSE_EXCEPTION, ON_PARSE_EXCEPTION_STR

Constructor Summary

Constructors
Constructor and Description

Source()
Instantiates a new source.

Constructors
Constructor and Description
`Source()` Instantiates a new source.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addVariable(Variable var)` Adds the variable.
`void`	`decUsageCounter()` Decrements usage counter.
`void`	`enableMetrics(boolean value)` Enable/disable capturing metrics.
`ListHashMap<String,Task>`	`getBeforeEtlTasks()` Gets the tasks which are executed before etl framework starts processing the `DataSet` object associated with the particular scenario block but after initializing is done.
`String`	`getBeforePrepareSourceQuery()` Gets the JavaScript code to execute before prepare source query.
`Block.BlockType`	`getBlockType()` Gets the {#link BlockType}.
`StreamingCommitPolicy`	`getCommitPolicy()` Gets the commit policy.
`Connection`	`getConnection()` Gets the actual JDBC connection associated with the scenario block.
`String`	`getConnectionName()` Gets the name of the connection associated with the scenario block.
`String`	`getDataReaderClassName()` Gets the data reader class name.
`Map<String,String>`	`getDataReaderParams()` Gets the data reader params.
`DataSet`	`getDataSet()` Gets the `DataSet` object associated with the scenario block.
`String`	`getDataWriterClassName()` Gets the data writer class name.
`Map<String,String>`	`getDataWriterParams()` Gets the data writer params.
`String`	`getDefaultConnectionName()` Gets the default connection name.
`Map<String,Object>`	`getDefaultValues(Scenario scenario)` Gets the default values for the model used to edit the source.
`String`	`getDriverClassName()` Gets the driver class name.
`Point`	`getEndLocation()` Gets the end location.
`String`	`getExclude()` Gets the comma separated list of the excluded table for the wildcard matching.
`int`	`getFetchSize()` Gets the fetch size.
`Map<String,String>`	`getFiles()` Gets the names of the extracted files.
`String`	`getHighWatermarkField()` Gets the high watermark field.
`String`	`getIdForException()` Gets the id for exception.
`String`	`getInclude()` Gets the comma separated list of the included table for the wildcard matching.
`ListHashMap<String,Task>`	`getInlineTasks()` Gets the tasks which are executed for each row of the `DataSet` object associated with the scenario block.
`String`	`getKeyFields()` Gets the name of the key fields.
`String`	`getKeyName()` Gets the key name.
`String`	`getLinkedSourceName()` Gets the name of the linked source.
`TypedKeyValue<Point,Point>`	`getLocation(String key)` Gets the location of the collection artifact such as tasks, variables, etc.
`Map<String,TypedKeyValue<Point,Point>>`	`getLocations()` The the locations of the collection artifacts such as tasks, variables, etc.
`String`	`getMatch()` Gets the match.
`int`	`getMaxFiles()` Gets the max files to process when wildcard processing is nabled.
`int`	`getMaxRows()` Gets the maximum number of rows to extract.
`String`	`getName()` Gets the name.
`String`	`getObjectName()` Gets the name of the object.
`ListHashMap<String,Task>`	`getOnExceptionTasks()` Gets the tasks which are executed when there is an exception during processing of the etl block.
`int`	`getOnPersistDataSet()` Gets the action on "persist data set" event.
`int`	`getOnPersistDataSet(String action)` Gets the action on "persist data set" from then given action name.
`String`	`getOnPersistDataSetAction()` Gets the on persist data set action.
`int`	`getOnPopulateDataSet()` Gets the action on "populate data set" event.
`int`	`getOnPopulateDataSet(String action)` Gets the action on "populate data set" event from the given action name.
`String`	`getOnPopulateDataSetAction()` Gets the on populate data set action.
`String`	`getOriginalName()` Gets the original block name.
`String`	`getOutputParamIndexes()` Gets the comma delimited list of of indexes for the output parameters to get a result set from callable statement.
`String`	`getOwnerName()` Gets the owner name.
`List<Integer>`	`getParamIndexes()` Gets the array of indexes for the output parameters to get a result set from callable statement.
`ListHashMap<String,Task>`	`getPostTasks()` Gets the tasks which are executed after etl framework finished with the processing of the particular scenario block.
`String`	`getSql()` Gets the sql.
`Point`	`getStartLocation()` Gets the start location.
`SqlStatementType`	`getStatementType()` Gets the statement type.
`ListHashMap<String,Task>`	`getTasks()` Gets the tasks which are executed before etl framework starts processing of the particular scenario block.
`int`	`getUsageCounter()` Gets the usage counter.
`String`	`getUsing()` Gets the "using".
`Variable`	`getVariable(String... name)` Gets the variable by name.
`ListHashMap<String,Variable>`	`getVariables()` Gets the variables.
`void`	`incUsageCounter()` Increments usage counter.
`boolean`	`isEmpty()` Checks if `DataSet` object associated with the scenario block is empty.
`boolean`	`isEnabled()` Checks if scenario block is enabled.
`boolean`	`isEncoded()` Checks if encoded flag set for the `DataSet` object associated with the scenario block.
`boolean`	`isIgnoreEmpty()` Checks if ignore empty source flag is set.
`boolean`	`isIgnoreNoRecords()` Checks if ignore empty no records in the source flag is set.
`Boolean`	`isIndependent()` Checks if source is independent.
`boolean`	`isMandatory()` Checks if source is mandatory.
`boolean`	`isMetricsEnabled()` Checks if capturing metrics enabled.
`boolean`	`isNewConnection()` Checks if new source connection should be created for each transformation.
`boolean`	`isNewConnectionSourceQuery()` Checks if new connection should be created for each SQL in source query.
`boolean`	`isParallel()` Checks if code for the particular scenario block can be executed in the separate thread.
`boolean`	`isStub()` Checks if source is a stub.
`boolean`	`isTrackingEnabled()` Checks if tracking is allowed.
`boolean`	`isUpdateIndexOnChange()` Checks if index should be updated automatically.
`boolean`	`isWildcardParallel()` Checks if parallel processing of wildcard sources is enabled.
`boolean`	`noConnection()` Check if no database connection should be associated with the block.
`void`	`setBeforeEtlTasks(ListHashMap<String,Task> value)` Sets the tasks which are executed before etl framework starts processing the `DataSet` object associated with the particular scenario block but after initializing is done.
`void`	`setBeforePrepareSourceQuery(String beforePrepareSourceQuery)` Sets the JavaScript code to execute before prepare source query.
`void`	`setBlockType(Block.BlockType value)` Sets the block type.
`void`	`setCommitPolicy(StreamingCommitPolicy commitPolicy)` Sets the commit policy.
`void`	`setConnection(Connection value)` Sets the actual JDBC connection associated with the scenario block.
`void`	`setConnectionName(String value)` Sets the name of the connection associated with the scenario block.
`void`	`setDataReaderClassName(String value)` Sets the data reader class name.
`void`	`setDataReaderParams(Map<String,String> value)` Sets the data reader params.
`void`	`setDataSet(DataSet value, boolean adjust)` Sets the `DataSet` object associated with the scenario block.
`void`	`setDataWriterClassName(String value)` Sets the data writer class name.
`void`	`setDataWriterParams(Map<String,String> value)` Sets the data writer params.
`void`	`setDriverClassName(String value)` Sets the driver class name.
`void`	`setEnabled(boolean value)` Sets the enabled property of the scenario block.
`void`	`setEncoded(boolean value)` Sets the encoded flag for the `DataSet` object associated with the scenario block.
`void`	`setExclude(String exclude)` Sets the list of the excluded tables for wildcard matching.
`void`	`setFetchSize(int fetchSize)` Sets the fetch size.
`void`	`setHighWatermarkField(String highWatermarkField)` Sets the high watermark field.
`void`	`setIgnoreEmpty(boolean ignoreEmpty)` Sets the ignore empty source flag.
`void`	`setIgnoreNoRecords(boolean ignoreNoRecords)` Sets the ignore no records in source flag.
`void`	`setInclude(String include)` Sets the list of the included tables for wildcard matching.
`void`	`setInlineTasks(ListHashMap<String,Task> value)` Sets the tasks which are executed for each row of the `DataSet` object associated with the scenario block.
`void`	`setIsEmpty(boolean value)` Sets the state of the field `isEmpty` for the scenario block regardless of the actual state of the `DataSet` object.
`void`	`setIsIndependent(Boolean value)` Sets the "is independent" flag.
`void`	`setKeyFields(String value)` Sets the name of the key fields.
`void`	`setKeyName(String value)` Sets the key name.
`void`	`setLinkedSourceName(String value)` Sets the name of the linked source.
`void`	`setLocation(boolean doSet, String key, org.w3c.dom.Node treesNode)` Set the location for the artifacts such as tasks, variables, etc.
`void`	`setLocation(boolean doSet, String key, TypedKeyValue<Point,Point> location)` Set the location for the artifacts such as tasks, variables, etc.
`void`	`setMandatory(boolean value)` Sets the "mandatory" flag.
`void`	`setMatch(String match)` Sets the match.
`void`	`setMaxFiles(int maxFiles)` Sets the max files to process when wildcard processing is enabled.
`void`	`setMaxRows(int value)` Sets the maximum number of rows to extract.
`void`	`setName(String value)` Sets the name.
`void`	`setNewConnection(boolean newConnection)` Sets the "new connection" flag.
`void`	`setNewConnectionSourceQuery(boolean newConnectionSourceQuery)` Sets the "new connection source query" flag.
`void`	`setNoConnection(boolean value)` Sets the "no connection" flag.
`void`	`setObjectName(String value)` Sets the name of the object.
`void`	`setOnExceptionTasks(ListHashMap<String,Task> value)` Sets the tasks which are executed when there is an exception during processing of the etl block.
`void`	`setOnPersistDataSet(int value)` Sets the action for "on persist data set" event.
`void`	`setOnPersistDataSet(String action)` Sets the action for "on persist data set" event.
`void`	`setOnPopulateDataSet(int value)` Sets the action for "on populate data set" event.
`void`	`setOnPopulateDataSet(String action)` Sets the action for "on populate data set" event.
`void`	`setOriginalName(String name)` Sets the original block name.
`void`	`setOutputParamIndexes(String value)` Sets the comma delimited list of of indexes for the output parameters to get a result set from callable statement.
`void`	`setOwnerName(String value)` Sets the owner name.
`void`	`setParallel(boolean value)` Sets the the property isParallel for the scenario block.
`void`	`setPostTasks(ListHashMap<String,Task> value)` Sets the tasks which are executed after etl framework finished with the processing of the particular scenario block.
`void`	`setSql(String value)` Sets the sql.
`void`	`setStatementType(SqlStatementType value)` Sets the statement type.
`void`	`setTasks(ListHashMap<String,Task> value)` Sets the tasks which are executed before etl framework starts processing of the particular scenario block.
`void`	`setTrackingEnabled(boolean trackingEnabled)` Sets the tracking enabled.
`void`	`setUpdateIndexOnChange(boolean value)` Sets the value for the "update index on change event" flag.
`void`	`setUsing(String value)` Sets the "using".
`void`	`setVariables(ListHashMap<String,Variable> value)` Sets the variables for the block.
`void`	`setWildcardParallel(boolean wildcardParallel)` Sets the value of the flag which controls if parallel processing of wildcard sources is enabled.

Methods inherited from class com.toolsverse.etl.common.OnException
findException, getExceptionActions, getExceptionMask, getMessage, getOnExceptionAction, getOnExceptionActions, handleException, hasAllExceptions, isSavePoint, log, setExceptionMask, setMessage, setOnExceptionAction, setOnExceptionAction, setSavePoint

Methods inherited from class com.toolsverse.etl.common.ConditionalExecution
getConditionCode, getConditionConnectionName, getConditionLang, setConditionCode, setConditionConnectionName, setConditionLang

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SOURCE_ATTR
```
public static final String SOURCE_ATTR
```
    SOURCE_ATTR.
    
    See Also:
    
    Constant Field Values
  - SOURCE_SQL_ATTR
```
public static final String SOURCE_SQL_ATTR
```
    SOURCE_SQL_ATTR.
    
    See Also:
    
    Constant Field Values
  - NAME_ATTR
```
public static final String NAME_ATTR
```
    NAME_ATTR.
    
    See Also:
    
    Constant Field Values
  - KEY_FIELDS_ATTR
```
public static final String KEY_FIELDS_ATTR
```
    KEY_FIELDS_ATTR.
    
    See Also:
    
    Constant Field Values
  - SQL_STATEMENT_TYPE_ATTR
```
public static final String SQL_STATEMENT_TYPE_ATTR
```
    EXTRACT SQL STATEMENT TYPE ATTR.
    
    See Also:
    
    Constant Field Values
  - SQL_STATEMENT_PARAM_INDEX_ATTR
```
public static final String SQL_STATEMENT_PARAM_INDEX_ATTR
```
    OUTPUT PARAMETER INDEX FOR CALLABLE STATEMENT ATTR.
    
    See Also:
    
    Constant Field Values
  - SQL_STATEMENT_OUTPUT_PARAM_INDEEX_ATTR
```
public static final String SQL_STATEMENT_OUTPUT_PARAM_INDEEX_ATTR
```
    OUTPUT PARAMETERS INDEX ATTR.
    
    See Also:
    
    Constant Field Values
  - LIMIT_ATTR
```
public static final String LIMIT_ATTR
```
    LIMIT_ATTR.
    
    See Also:
    
    Constant Field Values
  - MAX_FILES_ATTR
```
public static final String MAX_FILES_ATTR
```
    MAX_FILS_ATTR.
    
    See Also:
    
    Constant Field Values
  - UPDATE_KEY_ATTR
```
public static final String UPDATE_KEY_ATTR
```
    UPDATE_KEY_ATTR.
    
    See Also:
    
    Constant Field Values
  - OWNER_ATTR
```
public static final String OWNER_ATTR
```
    OWNER_ATTR.
    
    See Also:
    
    Constant Field Values
  - OBJECT_NAME_ATTR
```
public static final String OBJECT_NAME_ATTR
```
    OBJECT_NAME_ATTR.
    
    See Also:
    
    Constant Field Values
  - LINKED_SOURCE_ATTR
```
public static final String LINKED_SOURCE_ATTR
```
    LINKED_SOURCE_ATTR.
    
    See Also:
    
    Constant Field Values
  - ON_PERSIST_ATTR
```
public static final String ON_PERSIST_ATTR
```
    ON_PERSIST_ATTR.
    
    See Also:
    
    Constant Field Values
  - ON_POPULATE_ATTR
```
public static final String ON_POPULATE_ATTR
```
    ON_POPULATE_ATTR.
    
    See Also:
    
    Constant Field Values
  - NO_CONNECTION_ATTR
```
public static final String NO_CONNECTION_ATTR
```
    NO_CONNECTION_ATTR.
    
    See Also:
    
    Constant Field Values
  - PARALLEL_ATTR
```
public static final String PARALLEL_ATTR
```
    PARALLEL_ATTR.
    
    See Also:
    
    Constant Field Values
  - WILDCARD_PARALLEL_ATTR
```
public static final String WILDCARD_PARALLEL_ATTR
```
    WILDCARD_PARALLEL_ATTR.
    
    See Also:
    
    Constant Field Values
  - NEW_CONNECTION_ATTR
```
public static final String NEW_CONNECTION_ATTR
```
    NEW_CONNECTION_ATTR.
    
    See Also:
    
    Constant Field Values
  - NEW_CONNECTION_SOURCE_QUERY_ATTR
```
public static final String NEW_CONNECTION_SOURCE_QUERY_ATTR
```
    NEW_CONNECTION_SOURCE_QUERY_ATTR.
    
    See Also:
    
    Constant Field Values
  - INDEPENDENT_ATTR
```
public static final String INDEPENDENT_ATTR
```
    INDEPENDENT_ATTR.
    
    See Also:
    
    Constant Field Values
  - EMPTY_ATTR
```
public static final String EMPTY_ATTR
```
    EMPTY_ATTR.
    
    See Also:
    
    Constant Field Values
  - IGNORE_EMPTY_ATTR
```
public static final String IGNORE_EMPTY_ATTR
```
    IGNORE_EMPTY_ATTR.
    
    See Also:
    
    Constant Field Values
  - IGNORE_NO_RECORDS_ATTR
```
public static final String IGNORE_NO_RECORDS_ATTR
```
    IGNORE_NO_RECORDS_ATTR.
    
    See Also:
    
    Constant Field Values
  - MANDATORY_ATTR
```
public static final String MANDATORY_ATTR
```
    MANDATORY_ATTR.
    
    See Also:
    
    Constant Field Values
  - ENABLED_ATTR
```
public static final String ENABLED_ATTR
```
    ENABLED_ATTR.
    
    See Also:
    
    Constant Field Values
  - METRICS_ENABLED_ATTR
```
public static final String METRICS_ENABLED_ATTR
```
    The METRICS_ENABLED_ATTR.
    
    See Also:
    
    Constant Field Values
  - TRACKING_ENABLED_ATTR
```
public static final String TRACKING_ENABLED_ATTR
```
    The TRACKING_ENABLED_ATTR.
    
    See Also:
    
    Constant Field Values
  - ENCODE_ATTR
```
public static final String ENCODE_ATTR
```
    ENCODE_ATTR.
    
    See Also:
    
    Constant Field Values
  - ETL_DRIVER_ATTR
```
public static final String ETL_DRIVER_ATTR
```
    ETL_DRIVER_ATTR.
    
    See Also:
    
    Constant Field Values
  - CONNECTION_ATTR
```
public static final String CONNECTION_ATTR
```
    CONNECTION_ATTR.
    
    See Also:
    
    Constant Field Values
  - SQL_ATTR
```
public static final String SQL_ATTR
```
    SQL_ATTR.
    
    See Also:
    
    Constant Field Values
  - BEFORE_SQL_ATTR
```
public static final String BEFORE_SQL_ATTR
```
    BEFORE_SQL_ATTR.
    
    See Also:
    
    Constant Field Values
  - USING_ATTR
```
public static final String USING_ATTR
```
    USING_ATTR.
    
    See Also:
    
    Constant Field Values
  - EXCLUDE_ATTR
```
public static final String EXCLUDE_ATTR
```
    EXCLUDE_ATTR.
    
    See Also:
    
    Constant Field Values
  - INCLUDE_ATTR
```
public static final String INCLUDE_ATTR
```
    INCLUCE_ATTR.
    
    See Also:
    
    Constant Field Values
  - MATCH_ATTR
```
public static final String MATCH_ATTR
```
    MATCH_ATTR.
    
    See Also:
    
    Constant Field Values
  - ON_EXCEPTION_ACTION_ATTR
```
public static final String ON_EXCEPTION_ACTION_ATTR
```
    ON_EXCEPTION_ACTION_ATTR.
    
    See Also:
    
    Constant Field Values
  - ON_EXCEPTION_MASK_ATTR
```
public static final String ON_EXCEPTION_MASK_ATTR
```
    ON_EXCEPTION_MASK_ATTR.
    
    See Also:
    
    Constant Field Values
  - COND_lANG_ATTR
```
public static final String COND_lANG_ATTR
```
    COND_lANG_ATTR.
    
    See Also:
    
    Constant Field Values
  - COND_CONNECTION_ATTR
```
public static final String COND_CONNECTION_ATTR
```
    COND_CONNECTION_ATTR.
    
    See Also:
    
    Constant Field Values
  - CONDITION_ATTR
```
public static final String CONDITION_ATTR
```
    CONDITION_ATTR.
    
    See Also:
    
    Constant Field Values
  - READER_ATTR
```
public static final String READER_ATTR
```
    READER_ATTR.
    
    See Also:
    
    Constant Field Values
  - WRITER_ATTR
```
public static final String WRITER_ATTR
```
    WRITER_ATTR.
    
    See Also:
    
    Constant Field Values
  - FETCH_SIZE_ATTR
```
public static final String FETCH_SIZE_ATTR
```
    FETCH_SIZE_ATTR.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Source
```
public Source()
```
    Instantiates a new source.
- Method Detail
  - decUsageCounter
```
public void decUsageCounter()
```
    Decrements usage counter.
  - enableMetrics
```
public void enableMetrics(boolean value)
```
    Description copied from interface: Block
    
    Enable/disable capturing metrics.
    
    Specified by:
    
    enableMetrics in interface Block
    
    Parameters:
    
    value - the value
  - getBeforeEtlTasks
```
public ListHashMap<String,Task> getBeforeEtlTasks()
```
    Description copied from interface: Block
    
    Gets the tasks which are executed before etl framework starts processing the DataSet object associated with the particular scenario block but after initializing is done. For example: after metadata are collected.
    
    Specified by:
    
    getBeforeEtlTasks in interface Block
    
    Returns:
    
    the tasks as an ListHashMap object
  - getBlockType
```
public Block.BlockType getBlockType()
```
    Description copied from interface: Block
    
    Gets the {#link BlockType}.
    
    Specified by:
    
    getBlockType in interface Block
    
    Returns:
    
    the block type
  - getConnection
```
public Connection getConnection()
```
    Description copied from interface: Block
    
    Gets the actual JDBC connection associated with the scenario block.
    
    Specified by:
    
    getConnection in interface Block
    
    Returns:
    
    the connection
  - getConnectionName
```
public String getConnectionName()
```
    Description copied from interface: Block
    
    Gets the name of the connection associated with the scenario block. By default (if not named specifically) the name of the source connection is a "source" and the name of the destination connection is "dest". Connection can be referenced by name from the scenario block such as Source or Destination
    Example of named connection in the scenario file:
    
    <destination>
    
    <name>image</name>
    
    <source>image</source>
    
    <load>
    
    <connection>mssql</connection>
    
    <driver>com.toolsverse.etl.driver.mysql.MsSqlDriver</driver>
    
    </load>
    
    </destination>
    
    Specified by:
    
    getConnectionName in interface Block
    
    Returns:
    
    the name of the connection
  - getDataReaderClassName
```
public String getDataReaderClassName()
```
    Gets the data reader class name. Data reader must implement DataSetConnector interface.
    
    Returns:
    
    the data reader class name
  - getDataReaderParams
```
public Map<String,String> getDataReaderParams()
```
    Gets the data reader params.
    
    Returns:
    
    the data reader params
  - getDataSet
```
public DataSet getDataSet()
```
    Description copied from interface: Block
    
    Gets the DataSet object associated with the scenario block.
    
    Specified by:
    
    getDataSet in interface Block
    
    Returns:
    
    the data set
  - getDataWriterClassName
```
public String getDataWriterClassName()
```
    Gets the data writer class name. Data writer must implement DataSetConnector interface.
    
    Returns:
    
    the data writer class name
  - getDataWriterParams
```
public Map<String,String> getDataWriterParams()
```
    Gets the data writer params.
    
    Returns:
    
    the data writer params
  - getDefaultConnectionName
```
public String getDefaultConnectionName()
```
    Description copied from class: ConditionalExecution
    
    Gets the default connection name.
    
    Specified by:
    
    getDefaultConnectionName in class ConditionalExecution
    
    Returns:
    
    the default connection name
  - getDefaultValues
```
public Map<String,Object> getDefaultValues(Scenario scenario)
```
    Gets the default values for the model used to edit the source.
    
    Parameters:
    
    scenario - the scenario
    
    Returns:
    
    the default values
  - getDriverClassName
```
public String getDriverClassName()
```
    Description copied from interface: Block
    
    Gets the driver class name.
    
    Specified by:
    
    getDriverClassName in interface Block
    
    Returns:
    
    the driver class name
  - getEndLocation
```
public Point getEndLocation()
```
    Description copied from interface: LocationProvider
    
    Gets the end location.
    
    Specified by:
    
    getEndLocation in interface LocationProvider
    
    Returns:
    
    the location
  - getHighWatermarkField
```
public String getHighWatermarkField()
```
    Description copied from interface: Block
    
    Gets the high watermark field.
    
    Specified by:
    
    getHighWatermarkField in interface Block
    
    Returns:
    
    the high watermark field
  - getInlineTasks
```
public ListHashMap<String,Task> getInlineTasks()
```
    Description copied from interface: Block
    
    Gets the tasks which are executed for each row of the DataSet object associated with the scenario block.
    
    Specified by:
    
    getInlineTasks in interface Block
    
    Returns:
    
    the inline tasks as an ListHashMap object
  - getKeyFields
```
public String getKeyFields()
```
    Description copied from class: OnException
    
    Gets the name of the key fields. Used by MergeHandler to generate where clause for the update statement.
    
    Overrides:
    
    getKeyFields in class OnException
    
    Returns:
    
    the name of the key fields
  - getKeyName
```
public String getKeyName()
```
    Gets the key name.
    
    Returns:
    
    the key name
  - getLinkedSourceName
```
public String getLinkedSourceName()
```
    Gets the name of the linked source.
    
    Returns:
    
    the name of the linked source
  - getLocation
```
public TypedKeyValue<Point,Point> getLocation(String key)
```
    Description copied from interface: Block
    
    Gets the location of the collection artifact such as tasks, variables, etc.
    
    Specified by:
    
    getLocation in interface Block
    
    Parameters:
    
    key - the artifact type name
    
    Returns:
    
    the location
  - getLocations
```
public Map<String,TypedKeyValue<Point,Point>> getLocations()
```
    Description copied from interface: Block
    
    The the locations of the collection artifacts such as tasks, variables, etc. The key is an artifact type.
    
    Specified by:
    
    getLocations in interface Block
    
    Returns:
    
    the locations
  - getMaxRows
```
public int getMaxRows()
```
    Gets the maximum number of rows to extract.
    
    Returns:
    
    the maximum number of rows to extract
  - getName
```
public String getName()
```
    Description copied from class: OnException
    
    Gets the name.
    
    Specified by:
    
    getName in interface Block
    
    Overrides:
    
    getName in class OnException
    
    Returns:
    
    the name
  - getObjectName
```
public String getObjectName()
```
    Gets the name of the object. Can be a table name. It used by registered code generator to create database specific load code for the destination.
    
    Returns:
    
    the object name
  - getOnExceptionTasks
```
public ListHashMap<String,Task> getOnExceptionTasks()
```
    Description copied from interface: Block
    
    Gets the tasks which are executed when there is an exception during processing of the etl block.
    
    Specified by:
    
    getOnExceptionTasks in interface Block
    
    Returns:
    
    the on exception tasks as an ListHashMap object
  - getOnPersistDataSet
```
public int getOnPersistDataSet()
```
    Gets the action on "persist data set" event.
    
    Returns:
    
    the action on "persist data set" event
  - getOnPersistDataSet
```
public int getOnPersistDataSet(String action)
```
    Gets the action on "persist data set" from then given action name.
    
    Parameters:
    
    action - the action
    
    Returns:
    
    the action on "persist data set" event
  - getOnPersistDataSetAction
```
public String getOnPersistDataSetAction()
```
    Gets the on persist data set action.
    
    Returns:
    
    the on persist data set action
  - getOnPopulateDataSet
```
public int getOnPopulateDataSet()
```
    Gets the action on "populate data set" event.
    
    Returns:
    
    the action on "populate data set" event
  - getOnPopulateDataSet
```
public int getOnPopulateDataSet(String action)
```
    Gets the action on "populate data set" event from the given action name.
    
    Parameters:
    
    action - the action
    
    Returns:
    
    the action on "populate data set" event
  - getOnPopulateDataSetAction
```
public String getOnPopulateDataSetAction()
```
    Gets the on populate data set action.
    
    Returns:
    
    the on populate data set action
  - getOutputParamIndexes
```
public String getOutputParamIndexes()
```
    Gets the comma delimited list of of indexes for the output parameters to get a result set from callable statement.
    
    Returns:
    
    the comma delimited list of of indexes
  - getOwnerName
```
public String getOwnerName()
```
    Gets the owner name.
    
    Returns:
    
    the owner name
  - getParamIndexes
```
public List<Integer> getParamIndexes()
```
    Gets the array of indexes for the output parameters to get a result set from callable statement.
    
    Returns:
    
    the array of indexes
  - getPostTasks
```
public ListHashMap<String,Task> getPostTasks()
```
    Description copied from interface: Block
    
    Gets the tasks which are executed after etl framework finished with the processing of the particular scenario block.
    
    Specified by:
    
    getPostTasks in interface Block
    
    Returns:
    
    the post tasks as an ListHashMap object
  - getSql
```
public String getSql()
```
    Gets the sql.
    
    Returns:
    
    the sql
  - getStartLocation
```
public Point getStartLocation()
```
    Description copied from interface: LocationProvider
    
    Gets the start location.
    
    Specified by:
    
    getStartLocation in interface LocationProvider
    
    Returns:
    
    the location
  - getStatementType
```
public SqlStatementType getStatementType()
```
    Gets the statement type.
    
    Returns:
    
    the statement type
  - getTasks
```
public ListHashMap<String,Task> getTasks()
```
    Description copied from interface: Block
    
    Gets the tasks which are executed before etl framework starts processing of the particular scenario block.
    
    Specified by:
    
    getTasks in interface Block
    
    Returns:
    
    the tasks as an ListHashMap object
  - getUsageCounter
```
public int getUsageCounter()
```
    Gets the usage counter.
    
    Returns:
    
    the usage counter
  - getUsing
```
public String getUsing()
```
    Gets the "using". "Using" is comma delimited string of bind variables.
    
    Returns:
    
    the "using"
  - getVariable
```
public Variable getVariable(String... name)
```
    Description copied from interface: Block
    
    Gets the variable by name.
    
    Specified by:
    
    getVariable in interface Block
    
    Parameters:
    
    name - the name of the variable
    
    Returns:
    
    the variable
  - getVariables
```
public ListHashMap<String,Variable> getVariables()
```
    Description copied from interface: Block
    
    Gets the variables.
    
    Specified by:
    
    getVariables in interface Block
    
    Returns:
    
    the variables
  - addVariable
```
public void addVariable(Variable var)
```
    Adds the variable.
    
    Parameters:
    
    var - the variable
  - incUsageCounter
```
public void incUsageCounter()
```
    Increments usage counter.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Block
    
    Checks if DataSet object associated with the scenario block is empty. Scenario block can be configured to be treated as empty regardless of the actual state of the DataSet object.
    
    Specified by:
    
    isEmpty in interface Block
    
    Returns:
    
    true, if empty
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: Block
    
    Checks if scenario block is enabled. For disabled blocks no code will be executed.
    
    Specified by:
    
    isEnabled in interface Block
    
    Returns:
    
    true, if enabled
  - isEncoded
```
public boolean isEncoded()
```
    Description copied from interface: Block
    
    Checks if encoded flag set for the DataSet object associated with the scenario block. Usually only Clob and Blob fields can be encoded. ETL framework uses open source implementation of the Base64 encoding.
    
    Specified by:
    
    isEncoded in interface Block
    
    Returns:
    
    true, if encoded
  - isIndependent
```
public Boolean isIndependent()
```
    Checks if source is independent. Independent source is not linked to any destination.
    
    Returns:
    
    true, if is independent
  - isMandatory
```
public boolean isMandatory()
```
    Checks if source is mandatory. Mandatory source must be extracted before load, otherwise extract and load can be combined to implement data streaming.
    
    Returns:
    
    true, if is mandatory
  - isMetricsEnabled
```
public boolean isMetricsEnabled()
```
    Description copied from interface: Block
    
    Checks if capturing metrics enabled.
    
    Specified by:
    
    isMetricsEnabled in interface Block
    
    Returns:
    
    true, if is metrics enabled
  - isParallel
```
public boolean isParallel()
```
    Description copied from interface: Block
    
    Checks if code for the particular scenario block can be executed in the separate thread.
    
    Specified by:
    
    isParallel in interface Block
    
    Returns:
    
    true, if is parallel
  - isStub
```
public boolean isStub()
```
    Checks if source is a stub. If source doesn't have sql or any tasks and there is no linked data reader it is a "stub" source. If multiple sources are configured to extract in parallel the "stub" can be used as a "gate" - all parallel tasks must be finished in order to pass through the gate.
    
    Returns:
    
    true, if it is a stub
  - isUpdateIndexOnChange
```
public boolean isUpdateIndexOnChange()
```
    Checks if index should be updated automatically.
    
    Returns:
    
    true, if index should be updated automatically on add/delete events
  - noConnection
```
public boolean noConnection()
```
    Description copied from interface: Block
    
    Check if no database connection should be associated with the block.
    
    Specified by:
    
    noConnection in interface Block
    
    Returns:
    
    true, if successful
  - setBeforeEtlTasks
```
public void setBeforeEtlTasks(ListHashMap<String,Task> value)
```
    Description copied from interface: Block
    
    Sets the tasks which are executed before etl framework starts processing the DataSet object associated with the particular scenario block but after initializing is done. For example after metadata are collected. Tasks get instantiated by parsing scenario file.
    
    Specified by:
    
    setBeforeEtlTasks in interface Block
    
    Parameters:
    
    value - the new before etl tasks
  - setBlockType
```
public void setBlockType(Block.BlockType value)
```
    Sets the block type.
    
    Parameters:
    
    value - the new block type
  - setConnection
```
public void setConnection(Connection value)
```
    Description copied from interface: Block
    
    Sets the actual JDBC connection associated with the scenario block.
    
    Specified by:
    
    setConnection in interface Block
    
    Parameters:
    
    value - the new connection
  - setConnectionName
```
public void setConnectionName(String value)
```
    Description copied from interface: Block
    
    Sets the name of the connection associated with the scenario block.
    
    Specified by:
    
    setConnectionName in interface Block
    
    Parameters:
    
    value - the new name of the connection
  - setDataReaderClassName
```
public void setDataReaderClassName(String value)
```
    Sets the data reader class name. The data reader must implement DataSetConnector interface.
    
    Parameters:
    
    value - the new data reader class name
  - setDataReaderParams
```
public void setDataReaderParams(Map<String,String> value)
```
    Sets the data reader params.
    
    Parameters:
    
    value - the value
  - setDataSet
```
public void setDataSet(DataSet value,
                       boolean adjust)
```
    Description copied from interface: Block
    
    Sets the DataSet object associated with the scenario block.
    
    Specified by:
    
    setDataSet in interface Block
    
    Parameters:
    
    value - the new data set
    
    adjust - if true adjust data set fields
  - setDataWriterClassName
```
public void setDataWriterClassName(String value)
```
    Sets the data writer class name. The data writer must implement DataSetConnector interface.
    
    Parameters:
    
    value - the new data writer class name
  - setDataWriterParams
```
public void setDataWriterParams(Map<String,String> value)
```
    Sets the data writer params.
    
    Parameters:
    
    value - the value
  - setDriverClassName
```
public void setDriverClassName(String value)
```
    Description copied from interface: Block
    
    Sets the driver class name.
    
    Specified by:
    
    setDriverClassName in interface Block
    
    Parameters:
    
    value - the new driver class name
  - setEnabled
```
public void setEnabled(boolean value)
```
    Description copied from interface: Block
    
    Sets the enabled property of the scenario block. The default value is true.
    Example of the manually set enabled flag in the scenario file:
    
    <source enabled="No">
    
    <name>test</name>
    
    <extract>
    
    <sql>select * from test</sql>
    
    </extract>
    
    </source>
    
    Specified by:
    
    setEnabled in interface Block
    
    Parameters:
    
    value - the new enabled
  - setEncoded
```
public void setEncoded(boolean value)
```
    Description copied from interface: Block
    
    Sets the encoded flag for the DataSet object associated with the scenario block. By default all DataSet objects which contain Clob or Blob fields are encoded and compressed using zip algorithm.
    Example of the manually set encoded flag in the scenario file:
    
    <source encode="No">
    
    <name>clobs</name>
    
    <extract>
    
    <sql>select * from clobs</sql>
    
    </extract>
    
    </source>
    
    Specified by:
    
    setEncoded in interface Block
    
    Parameters:
    
    value - the new encoded
  - setHighWatermarkField
```
public void setHighWatermarkField(String highWatermarkField)
```
    Sets the high watermark field.
    
    Parameters:
    
    highWatermarkField - the new high watermark field
  - setInlineTasks
```
public void setInlineTasks(ListHashMap<String,Task> value)
```
    Description copied from interface: Block
    
    Sets the tasks which are executed for each row of the DataSet object associated with the scenario block. Inline tasks get instantiated by parsing scenario file.
    Example of the inline task in the scenario file:
    
    <tasks>
    
    <task>
    
    <name>replace</name>
    
    Specified by:
    
    setInlineTasks in interface Block
    
    Parameters:
    
    value - the value <class>com.toolsverse.etl.core.task.common.RegexpTransformator</class>
    
    <variables>
    
    <FIELD value="DESCRIPTION" />
    
    <REGEXP value="Substitution" />
    
    <REPLACE value="something" />
    
    </variables>
    
    </task>
    
    </tasks>
  - setIsEmpty
```
public void setIsEmpty(boolean value)
```
    Description copied from interface: Block
    
    Sets the state of the field isEmpty for the scenario block regardless of the actual state of the DataSet object. In the majority of cases etl framework can automatically set this flag however it doesn't hurt to do it manually.
    Example of the always empty scenario block in the scenario file:
    
    <source empty="Yes">
    
    <name>init</name>
    
    <extract>
    
    <tasks>
    
    <task>
    
    <name>prepare</name>
    
    <class>com.toolsverse.etl.core.task.sql.SqlTask</class>
    
    <sql>drop table tmp_cp</sql>
    
    <onexception action="ignore"/>
    
    </task>
    
    </tasks>
    
    </extract>
    
    </source>
    
    Specified by:
    
    setIsEmpty in interface Block
    
    Parameters:
    
    value - the new isEmpty
  - setIsIndependent
```
public void setIsIndependent(Boolean value)
```
    Sets the "is independent" flag.
    
    Parameters:
    
    value - the new value for "is independent" flag
  - setKeyFields
```
public void setKeyFields(String value)
```
    Description copied from class: OnException
    
    Sets the name of the key fields. Used by MergeHandler to generate where clause for the update statement.
    
    Overrides:
    
    setKeyFields in class OnException
    
    Parameters:
    
    value - the new names of the key fields
  - setKeyName
```
public void setKeyName(String value)
```
    Sets the key name.
    
    Parameters:
    
    value - the new key name
  - setLinkedSourceName
```
public void setLinkedSourceName(String value)
```
    Sets the name of the linked source.
    
    Parameters:
    
    value - the new name of the linked source.
  - setLocation
```
public void setLocation(boolean doSet,
                        String key,
                        org.w3c.dom.Node treesNode)
```
    Description copied from interface: Block
    
    Set the location for the artifacts such as tasks, variables, etc.
    
    Specified by:
    
    setLocation in interface Block
    
    Parameters:
    
    doSet - if false do not add location info for the artifact
    
    key - the artifact type
    
    treesNode - the DOM node which holds location information
  - setLocation
```
public void setLocation(boolean doSet,
                        String key,
                        TypedKeyValue<Point,Point> location)
```
    Description copied from interface: Block
    
    Set the location for the artifacts such as tasks, variables, etc.
    
    Specified by:
    
    setLocation in interface Block
    
    Parameters:
    
    doSet - if false do not add location info for the artifact
    
    key - the artifact type
    
    location - the location
  - setMandatory
```
public void setMandatory(boolean value)
```
    Sets the "mandatory" flag.
    
    Parameters:
    
    value - the new value for the "mandatory" flag
  - setMaxRows
```
public void setMaxRows(int value)
```
    Sets the maximum number of rows to extract.
    
    Parameters:
    
    value - the new maximum number of rows to extract
  - setName
```
public void setName(String value)
```
    Description copied from class: OnException
    
    Sets the name.
    
    Specified by:
    
    setName in interface Block
    
    Overrides:
    
    setName in class OnException
    
    Parameters:
    
    value - the new name
  - setNoConnection
```
public void setNoConnection(boolean value)
```
    Sets the "no connection" flag.
    
    Parameters:
    
    value - the new value for the "no connection" flag
  - setObjectName
```
public void setObjectName(String value)
```
    Sets the name of the object.
    Example of the objectname at the source level in the scenario file:
    
    <source>
    
    <name>test</name>
    
    <objectname>ABC.CLIENT</objectname>
    
    </source>
    
    Parameters:
    
    value - The new name of the object
  - setOnExceptionTasks
```
public void setOnExceptionTasks(ListHashMap<String,Task> value)
```
    Description copied from interface: Block
    
    Sets the tasks which are executed when there is an exception during processing of the etl block. On exception tasks get instantiated by parsing scenario file.
    Example of the post task in the scenario file:
    
    <tasks>
    
    <task scope="onexception">
    
    <name>delete</name>
    
    <class>com.toolsverse.etl.core.task.common.FileManagerTask</class>
    
    <variables>
    
    <COMMAND value="delete" />
    
    <SOURCE_TYPE value="file" />
    
    <FILES value="*.dat" />
    
    </variables>
    
    </task>
    
    </tasks>
    
    Specified by:
    
    setOnExceptionTasks in interface Block
    
    Parameters:
    
    value - the new post tasks
  - setOnPersistDataSet
```
public void setOnPersistDataSet(int value)
```
    Sets the action for "on persist data set" event.
    
    Parameters:
    
    value - the new action for the "on persist data set" event
  - setOnPersistDataSet
```
public void setOnPersistDataSet(String action)
```
    Sets the action for "on persist data set" event.
    
    Parameters:
    
    action - the new action for "on persist data set" event
  - setOnPopulateDataSet
```
public void setOnPopulateDataSet(int value)
```
    Sets the action for "on populate data set" event.
    
    Parameters:
    
    value - the new action for the "on populate data set" event
  - setOnPopulateDataSet
```
public void setOnPopulateDataSet(String action)
```
    Sets the action for "on populate data set" event.
    
    Parameters:
    
    action - the new action for "on populate data set" event
  - setOutputParamIndexes
```
public void setOutputParamIndexes(String value)
```
    Sets the comma delimited list of of indexes for the output parameters to get a result set from callable statement.
    
    Parameters:
    
    value - the new comma delimited list of of indexes
  - setOwnerName
```
public void setOwnerName(String value)
```
    Sets the owner name.
    
    Parameters:
    
    value - the new owner name
  - setParallel
```
public void setParallel(boolean value)
```
    Description copied from interface: Block
    
    Sets the the property isParallel for the scenario block. If set to true the code for this block can be executed in the separate thread. The default value is false.
    Example of the parallel scenario block in the scenario file:
    
    <source parallel="Yes">
    
    <name>test</name>
    
    <extract>
    
    <sql>select * from test</sql>
    
    </extract>
    
    </source>
    
    Specified by:
    
    setParallel in interface Block
    
    Parameters:
    
    value - the new parallel
  - setPostTasks
```
public void setPostTasks(ListHashMap<String,Task> value)
```
    Description copied from interface: Block
    
    Sets the tasks which are executed after etl framework finished with the processing of the particular scenario block. Post tasks get instantiated by parsing scenario file.
    Example of the post task in the scenario file:
    
    <tasks>
    
    <task scope="after">
    
    <name>delete</name>
    
    <class>com.toolsverse.etl.core.task.common.FileManagerTask</class>
    
    <variables>
    
    <COMMAND value="delete" />
    
    <SOURCE_TYPE value="file" />
    
    <FILES value="*.dat" />
    
    </variables>
    
    </task>
    
    </tasks>
    
    Specified by:
    
    setPostTasks in interface Block
    
    Parameters:
    
    value - the new post tasks
  - setSql
```
public void setSql(String value)
```
    Sets the sql.
    
    Parameters:
    
    value - the new sql
  - setStatementType
```
public void setStatementType(SqlStatementType value)
```
    Sets the statement type.
    
    Parameters:
    
    value - the new statement type
  - setTasks
```
public void setTasks(ListHashMap<String,Task> value)
```
    Description copied from interface: Block
    
    Sets the tasks which are executed before etl framework starts processing of the particular scenario block. Tasks get instantiated by parsing scenario file.
    Example of the task in the scenario file:
    
    <tasks>
    
    <task>
    
    <name>copy</name>
    
    <connection>dest</connection>
    
    <class>com.toolsverse.etl.core.task.oracle.OracleCopyTask</class>
    
    <sql>
    
    insert temp USING
    
    select * from some_table
    
    </sql>
    
    </task>
    
    </tasks>
    
    Specified by:
    
    setTasks in interface Block
    
    Parameters:
    
    value - the new tasks
  - setUpdateIndexOnChange
```
public void setUpdateIndexOnChange(boolean value)
```
    Sets the value for the "update index on change event" flag.
    
    Parameters:
    
    value - the new value for the "update index on change event" flag
  - setUsing
```
public void setUsing(String value)
```
    Sets the "using". "Using" is a comma delimited string with the names of the bind variables.
    
    Parameters:
    
    value - the new "using"
  - setVariables
```
public void setVariables(ListHashMap<String,Variable> value)
```
    Description copied from interface: Block
    
    Sets the variables for the block. Variables get instantiated by parsing scenario file.
    Example of the variables in the scenario file:
    
    <variables>
    
    <STEP_NUM function="getPk" />
    
    <CONFIG_NUM function="getFk" />
    
    <USER function="getUser" />
    
    <ID include="No" />
    
    </variables>
    
    Specified by:
    
    setVariables in interface Block
    
    Parameters:
    
    value - The new variables
  - isIgnoreEmpty
```
public boolean isIgnoreEmpty()
```
    Checks if ignore empty source flag is set.
    
    Returns:
    
    true, if ignore empty source flag is set
  - setIgnoreEmpty
```
public void setIgnoreEmpty(boolean ignoreEmpty)
```
    Sets the ignore empty source flag.
    
    Parameters:
    
    ignoreEmpty - the value of the ignore empty source flag
  - isIgnoreNoRecords
```
public boolean isIgnoreNoRecords()
```
    Checks if ignore empty no records in the source flag is set.
    
    Returns:
    
    true, if ignore no records in the source flag is set
  - setIgnoreNoRecords
```
public void setIgnoreNoRecords(boolean ignoreNoRecords)
```
    Sets the ignore no records in source flag.
    
    Parameters:
    
    ignoreNoRecords - the value of the ignore no records in the source flag
  - getFiles
```
public Map<String,String> getFiles()
```
    Description copied from interface: ReadTracker
    
    Gets the names of the extracted files.
    
    Specified by:
    
    getFiles in interface ReadTracker
    
    Returns:
    
    the files
  - isTrackingEnabled
```
public boolean isTrackingEnabled()
```
    Description copied from interface: ReadTracker
    
    Checks if tracking is allowed.
    
    Specified by:
    
    isTrackingEnabled in interface ReadTracker
    
    Returns:
    
    true, if tracking is allowed
  - setTrackingEnabled
```
public void setTrackingEnabled(boolean trackingEnabled)
```
    Sets the tracking enabled.
    
    Parameters:
    
    trackingEnabled - the new tracking enabled
  - getOriginalName
```
public String getOriginalName()
```
    Description copied from interface: Block
    
    Gets the original block name. The actual name is typically uppercased
    
    Specified by:
    
    getOriginalName in interface Block
    
    Returns:
    
    the original block name
  - setOriginalName
```
public void setOriginalName(String name)
```
    Description copied from interface: Block
    
    Sets the original block name. The actual name is typically uppercased.
    
    Specified by:
    
    setOriginalName in interface Block
    
    Parameters:
    
    name - String the new original name
  - getFetchSize
```
public int getFetchSize()
```
    Gets the fetch size.
    
    Returns:
    
    the fetch size
  - setFetchSize
```
public void setFetchSize(int fetchSize)
```
    Sets the fetch size.
    
    Parameters:
    
    fetchSize - the new fetch size
  - getIdForException
```
public String getIdForException()
```
    Description copied from class: ConditionalExecution
    
    Gets the id for exception.
    
    Specified by:
    
    getIdForException in class ConditionalExecution
    
    Returns:
    
    the id for exception
  - getExclude
```
public String getExclude()
```
    Gets the comma separated list of the excluded table for the wildcard matching.
    
    Returns:
    
    the excluded tables
  - setExclude
```
public void setExclude(String exclude)
```
    Sets the list of the excluded tables for wildcard matching.
    
    Parameters:
    
    exclude - the new exclude
  - getInclude
```
public String getInclude()
```
    Gets the comma separated list of the included table for the wildcard matching.
    
    Returns:
    
    the included tables
  - setInclude
```
public void setInclude(String include)
```
    Sets the list of the included tables for wildcard matching.
    
    Parameters:
    
    include - the coma separated list of included tables for the wildcard matching
  - setCommitPolicy
```
public void setCommitPolicy(StreamingCommitPolicy commitPolicy)
```
    Sets the commit policy.
    
    Parameters:
    
    commitPolicy - the new commit policy
  - getCommitPolicy
```
public StreamingCommitPolicy getCommitPolicy()
```
    Gets the commit policy.
    
    Returns:
    
    the commit policy
  - isWildcardParallel
```
public boolean isWildcardParallel()
```
    Checks if parallel processing of wildcard sources is enabled.
    
    Returns:
    
    true, parallel processing of wildcard sources is enabled.
  - setWildcardParallel
```
public void setWildcardParallel(boolean wildcardParallel)
```
    Sets the value of the flag which controls if parallel processing of wildcard sources is enabled.
    
    Parameters:
    
    wildcardParallel - boolean
  - getMatch
```
public String getMatch()
```
    Gets the match.
    
    Returns:
    
    the match
  - setMatch
```
public void setMatch(String match)
```
    Sets the match.
    
    Parameters:
    
    match - the new match
  - isNewConnection
```
public boolean isNewConnection()
```
    Checks if new source connection should be created for each transformation.
    
    Returns:
    
    true, if new source connection should be created for each transformation
  - setNewConnection
```
public void setNewConnection(boolean newConnection)
```
    Sets the "new connection" flag.
    
    Parameters:
    
    newConnection - boolean
  - getMaxFiles
```
public int getMaxFiles()
```
    Gets the max files to process when wildcard processing is nabled.
    
    Returns:
    
    the max files to process
  - setMaxFiles
```
public void setMaxFiles(int maxFiles)
```
    Sets the max files to process when wildcard processing is enabled.
    
    Parameters:
    
    maxFiles - the new max files to process
  - getBeforePrepareSourceQuery
```
public String getBeforePrepareSourceQuery()
```
    Gets the JavaScript code to execute before prepare source query.
    
    Returns:
    
    the JavaScript code to execute before prepare source query
  - setBeforePrepareSourceQuery
```
public void setBeforePrepareSourceQuery(String beforePrepareSourceQuery)
```
    Sets the JavaScript code to execute before prepare source query.
    
    Parameters:
    
    beforePrepareSourceQuery - String
  - isNewConnectionSourceQuery
```
public boolean isNewConnectionSourceQuery()
```
    Checks if new connection should be created for each SQL in source query.
    
    Returns:
    
    true, if new connection should be created for each SQL in source query
  - setNewConnectionSourceQuery
```
public void setNewConnectionSourceQuery(boolean newConnectionSourceQuery)
```
    Sets the "new connection source query" flag.
    
    Parameters:
    
    newConnectionSourceQuery - boolean

Class Source

Nested Class Summary

Nested classes/interfaces inherited from interface com.toolsverse.etl.core.engine.Block

Field Summary

Fields inherited from class com.toolsverse.etl.common.OnException

Constructor Summary

Method Summary

Methods inherited from class com.toolsverse.etl.common.OnException

Methods inherited from class com.toolsverse.etl.common.ConditionalExecution

Methods inherited from class Object

Field Detail

SOURCE_ATTR

SOURCE_SQL_ATTR

NAME_ATTR

KEY_FIELDS_ATTR

SQL_STATEMENT_TYPE_ATTR

SQL_STATEMENT_PARAM_INDEX_ATTR

SQL_STATEMENT_OUTPUT_PARAM_INDEEX_ATTR

LIMIT_ATTR

MAX_FILES_ATTR

UPDATE_KEY_ATTR

OWNER_ATTR

OBJECT_NAME_ATTR

LINKED_SOURCE_ATTR

ON_PERSIST_ATTR

ON_POPULATE_ATTR

NO_CONNECTION_ATTR

PARALLEL_ATTR

WILDCARD_PARALLEL_ATTR

NEW_CONNECTION_ATTR

NEW_CONNECTION_SOURCE_QUERY_ATTR

INDEPENDENT_ATTR

EMPTY_ATTR

IGNORE_EMPTY_ATTR

IGNORE_NO_RECORDS_ATTR

MANDATORY_ATTR

ENABLED_ATTR

METRICS_ENABLED_ATTR

TRACKING_ENABLED_ATTR

ENCODE_ATTR

ETL_DRIVER_ATTR

CONNECTION_ATTR

SQL_ATTR

BEFORE_SQL_ATTR

USING_ATTR

EXCLUDE_ATTR

INCLUDE_ATTR

MATCH_ATTR

ON_EXCEPTION_ACTION_ATTR

ON_EXCEPTION_MASK_ATTR

COND_lANG_ATTR

COND_CONNECTION_ATTR

CONDITION_ATTR

READER_ATTR

WRITER_ATTR

FETCH_SIZE_ATTR

Constructor Detail

Source

Method Detail

decUsageCounter

enableMetrics

getBeforeEtlTasks

getBlockType

getConnection

getConnectionName

getDataReaderClassName

getDataReaderParams

getDataSet

getDataWriterClassName

getDataWriterParams

getDefaultConnectionName

getDefaultValues

getDriverClassName

getEndLocation

getHighWatermarkField

getInlineTasks

getKeyFields

getKeyName

getLinkedSourceName

getLocation