com.toolsverse.etl.driver

Class CallableDriver

Object

com.toolsverse.etl.driver.AbstractDriver

com.toolsverse.etl.driver.CallableDriver

All Implemented Interfaces:

Driver, ExtensionModule, Serializable, Comparable<ExtensionModule>

Direct Known Subclasses:

Db2Driver, InformixDriver, MsSqlDriver, MySqlDriver, OracleDriver, PostgresDriver

public abstract class CallableDriver
extends AbstractDriver

The default abstract implementation of the Driver interface which supports callable statements.

Since:

1.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.toolsverse.etl.driver.AbstractDriver

ALLOWED_IDENT_CHARS

Fields inherited from interface com.toolsverse.etl.driver.Driver

BASE_CLASS_PATH, CASE_SENSITIVE_LOWER, CASE_SENSITIVE_LOWER_STR, CASE_SENSITIVE_UNDEFINED, CASE_SENSITIVE_UPPER, CASE_SENSITIVE_UPPER_STR, CMD_OPTIONS_PARAM, DB_PARAM, DDL_TYPE, ETL_CODE, FUNC_TYPE, PROC_TYPE, SERVER_PARAM, TABLE_TYPE

Fields inherited from interface com.toolsverse.ext.ExtensionModule

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

Constructor Summary

Constructors

Constructor and Description
CallableDriver()

Method Summary

Modifier and Type	Method and Description
protected abstract String	_getInitSql() Gets init sql.
protected abstract int	_getLinesLimit() Gets lines limit.
protected abstract int	_getMaxCharSize() Gets max char size.
protected abstract int	_getMaxPrecision() Gets max precision.
protected abstract int	_getMaxScale() Gets the max scale.
protected abstract int	_getMaxStringLiteralSize() Gets the max string literal size.
protected abstract int	_getMaxVarcharSize() Gets the max varchar size.
void	deleteStagingBinary(Connection conn, String tableName) Deletes staging table.
Object	getBlob(ResultSet rs, int pos) Gets the blob from the result set.
char	getCharUsedForColumnsWithSpaces() Gets the open and close char used for columns with spaces.
Object	getClob(ResultSet rs, int pos) Gets the CLOB from the result set.
TypedKeyValue<String,Integer>	getDestinationInfo(String sql) Gets the destination name and exception handler type from the sql.
String	getInitSql() Gets the initialization sql.
int	getLinesLimit() Gets the maximum number of lines in the sql block supported by database.
int	getMaxCharSize() Gets the maximum character size.
int	getMaxPrecision() Gets the maximum precision.
int	getMaxScale() Gets the maximum scale.
int	getMaxStringLiteralSize() Gets the maximum string literal size.
int	getMaxVarcharSize() Gets the maximum varchar size.
Object	getObject(ResultSet rs, int index, FieldDef fieldDef) Gets the object from result set.
String	getParentDriverName() Gets the parent driver class name.
String	getVarName(String name) Gets the variable name.
int	getWrongScale() Gets the wrong scale.
String	replaceOnException(String sql) Replaces sql on exception.
void	setBlob(PreparedStatement pstmt, Object value, int pos) Sets the blob field.
void	setClob(PreparedStatement pstmt, Object value, int pos) Sets the clob field.
void	setInitSql(String value) Sets the initialization sql.
void	setLinesLimit(int value) Sets the maximum number of lines in the sql block supported by database.
void	setMaxCharSize(int value) Sets the maximum char size.
void	setMaxPrecision(int value) Sets the maximum precision.
void	setMaxScale(int value) Sets the maximum scale.
void	setMaxStringLiteralSize(int value) Sets the maximum string literal size.
void	setMaxVarcharSize(int value) Sets the maximum varchar size.
void	setParentDriverName(String value) Sets the parent driver class name.
boolean	supportsIndexes() Supports indexes.
boolean	supportsScripts() If true the database supports extended sql, such as PLSQL, Transact SQL, etc.
void	updateStagingBlob(Connection conn, Variable var, String pkValue, Object value) Updates staging blob.
void	updateStagingClob(Connection conn, Variable var, String pkValue, Object value) Updates staging clob.
Object	value2StorageValue(int fieldType, Object value, Map<String,String> params, boolean booleanToNumber) Converts value for storage.

Methods inherited from class com.toolsverse.etl.driver.AbstractDriver

alwaysEncloseTableAndColumnsInQuotes, captureLog, compareTo, externalToolRequiresRedirect, filter, getAddColumnSql, getAllowedIdentifierChars, getAlterTableAddColumnSql, getAlterTableAddColumnSql, getAutotrace, getCaseSensitive, getCmdOptions, getColumns, getConfigFileName, getConnectionFile, getDefaultNull, getDeleteStatement, getDelimiter, getDisplayName, getErrorLinePattern, getExtensionRank, getHome, getIdentifierName, getIdentifierName, getInsertStatement, getLicensePropertyName, getLocalUnitClassPath, getMergeStatement, getNativeType, getObjectCheckSql, getParentDriver, getPostDeclareSql, getProperties, getSafeDelimiter, getSafeSql, getSelectStatement, getSqlForAutotrace, getSqlForExplainPlan, getSqlKeywordsFileName, getStartTransactionSql, getStringFieldSizeMultiplier, getTableName, getTablePrefixWhenAddingTable, getType, getUpdateStatement, isEqualDriver, isMergeInNonCallableSupported, needSeparateConnectionForDdl, requiresExecuteQuery, requiresRollbackAfterSqlError, requiresSeparateConnectionForIndexes, setAlwaysEncloseTableAndColumnsInQuotes, setCaseSensitive, setStringFieldSizeMultiplier, setUpConnection, supportColonInFormatter, supportsAutotrace, supportsLogging, supportsNotNullable, supportsParallelExtract, supportsParallelLoad, supportsParentDriver, supportsPreparedStatement, supportsPreparedStatementInParallelThreads, supportsPreparedStatementInTransaction, tableName2Name, typeHasSize

Methods inherited from class Object

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

Methods inherited from interface com.toolsverse.etl.driver.Driver

convertStringForStorage, convertValueForStorage, disableMetadataOnWrite, getBegin, getBeginSplited, getCallSql, getCmdForExternalTool, getCreateTableSql, getCursorLoopEndSql, getCursorLoopStartSql, getCursorRecAccessSql, getDeclare, getDeclareCursorEndSql, getDeclareCursorSql, getDeclareCursorVarSql, getDefaultFunctionClass, getDefaultType, getDropSql, getEnd, getEndSplited, getExplainPlan, getExternalToolName, getIf, getIfBegin, getIfElse, getIfEnd, getIoProcessorClassName, getJdbcDriverClassName, getMetadataClassName, getMetadataSelectClause, getMetadataWhereClause, getName, getOnException, getOnExceptionBegin, getOnExceptionEnd, getParamType, getPrecision, getPropsWizardResource, getSqlForExternalTool, getTempTableName, getTopSelectClause, getTopTrailClause, getTopWhereClause, getType, getUrlPattern, getVarDeclare, ifDoesNotExistSql, ifExistsSql, ignoreExceptionsDuringInit, openCloseConnectionOnDdl, requiresSemicolonInMerge, supportedJoinTypes, supportedSetOperations, supportsAnonymousBlocks, supportsBinaryInProc, supportsCallableStatement, supportsExplainPlan, supportsExternalTool, supportsInnerFunctions, supportsParamsInAnonymousBlocks, supportsRollbackAfterDDL

Methods inherited from interface com.toolsverse.ext.ExtensionModule

getIconPath, getVendor, getVersion, getXmlConfigFileName

Constructor Detail

CallableDriver

public CallableDriver()

Method Detail

_getInitSql

protected abstract String _getInitSql()

Gets init sql.

Returns:

the string

_getLinesLimit

protected abstract int _getLinesLimit()

Gets lines limit.

Returns:

the lines limit

_getMaxCharSize

protected abstract int _getMaxCharSize()

Gets max char size.

Returns:

the max char size

_getMaxPrecision

protected abstract int _getMaxPrecision()

Gets max precision.

Returns:

the max precision

_getMaxScale

protected abstract int _getMaxScale()

Gets the max scale.

Returns:

the max scale

_getMaxStringLiteralSize

protected abstract int _getMaxStringLiteralSize()

Gets the max string literal size.

Returns:

the max string literal size

_getMaxVarcharSize

protected abstract int _getMaxVarcharSize()

Gets the max varchar size.

Returns:

the max varchar size

deleteStagingBinary

public void deleteStagingBinary(Connection conn,
                                String tableName)
                         throws Exception

Description copied from interface: Driver

Deletes staging table.

Parameters:

conn - the connection

tableName - the table name

Throws:

Exception - in case of any error

getBlob

public Object getBlob(ResultSet rs,
                      int pos)
               throws Exception

Description copied from interface: Driver

Gets the blob from the result set.

Parameters:

rs - the result set

pos - the position ofr the blob field

Returns:

the blob

Throws:

Exception - in case of any error

getCharUsedForColumnsWithSpaces

public char getCharUsedForColumnsWithSpaces()

Description copied from interface: Driver

Gets the open and close char used for columns with spaces.

Returns:

the char user for columns with spaces

getClob

public Object getClob(ResultSet rs,
                      int pos)
               throws Exception

Description copied from interface: Driver

Gets the CLOB from the result set.

Parameters:

rs - the result set

pos - the position of the clob field

Returns:

the clob

Throws:

Exception - in case of any error

getDestinationInfo

public TypedKeyValue<String,Integer> getDestinationInfo(String sql)

Description copied from interface: Driver

Gets the destination name and exception handler type from the sql.

Parameters:

sql - the sql

Returns:

the destination name and exception handler type

getInitSql

public String getInitSql()

Description copied from interface: Driver

Gets the initialization sql. This sql is executed first for the etl scenario.

Returns:

the initialization sql

getLinesLimit

public int getLinesLimit()

Description copied from interface: Driver

Gets the maximum number of lines in the sql block supported by database.

Returns:

the lines limit

getMaxCharSize

public int getMaxCharSize()

Description copied from interface: Driver

Gets the maximum character size.

Returns:

the maximum character size

getMaxPrecision

public int getMaxPrecision()

Description copied from interface: Driver

Gets the maximum precision.

Returns:

the maximum precision

getMaxScale

public int getMaxScale()

Description copied from interface: Driver

Gets the maximum scale.

Returns:

the maximum scale

getMaxStringLiteralSize

public int getMaxStringLiteralSize()

Description copied from interface: Driver

Gets the maximum string literal size.

Returns:

the maximum string literal size

getMaxVarcharSize

public int getMaxVarcharSize()

Description copied from interface: Driver

Gets the maximum varchar size.

Returns:

the maximum varchar size

getObject

public Object getObject(ResultSet rs,
                        int index,
                        FieldDef fieldDef)
                 throws Exception

Description copied from interface: Driver

Gets the object from result set.

Parameters:

rs - the result set

index - the index of the field

fieldDef - the field type

Returns:

the object

Throws:

Exception - in case of any error

getParentDriverName

public String getParentDriverName()

Description copied from interface: Driver

Gets the parent driver class name.

Returns:

the parent driver class name

getVarName

public String getVarName(String name)

Description copied from interface: Driver

Gets the variable name.

Parameters:

name - the name

Returns:

the variable name

getWrongScale

public int getWrongScale()

Description copied from interface: Driver

Gets the wrong scale. If it is not -1 and jdbc driver returns it the actual scale will be set to -1.

Returns:

the wrong precision

replaceOnException

public String replaceOnException(String sql)

Description copied from interface: Driver

Replaces sql on exception.

Parameters:

sql - the sql

Returns:

the string

setBlob

public void setBlob(PreparedStatement pstmt,
                    Object value,
                    int pos)
             throws Exception

Description copied from interface: Driver

Sets the blob field.

Parameters:

pstmt - the prepared statement

value - the value

pos - the position for the blob field

Throws:

Exception - in case of any error

setClob

public void setClob(PreparedStatement pstmt,
                    Object value,
                    int pos)
             throws Exception

Description copied from interface: Driver

Sets the clob field.

Parameters:

pstmt - the prepared statement

value - the value

pos - the position of the clob field

Throws:

Exception - in case of any error

setInitSql

public void setInitSql(String value)

Description copied from interface: Driver

Sets the initialization sql.

Parameters:

value - the new initialization sql

setLinesLimit

public void setLinesLimit(int value)

Description copied from interface: Driver

Sets the maximum number of lines in the sql block supported by database.

Parameters:

value - the new lines limit

setMaxCharSize

public void setMaxCharSize(int value)

Description copied from interface: Driver

Sets the maximum char size.

Parameters:

value - the new maximum char size

setMaxPrecision

public void setMaxPrecision(int value)

Description copied from interface: Driver

Sets the maximum precision.

Parameters:

value - the new maximum precision

setMaxScale

public void setMaxScale(int value)

Description copied from interface: Driver

Sets the maximum scale.

Parameters:

value - the new maximum scale

setMaxStringLiteralSize

public void setMaxStringLiteralSize(int value)

Description copied from interface: Driver

Sets the maximum string literal size.

Parameters:

value - the new maximum string literal size

setMaxVarcharSize

public void setMaxVarcharSize(int value)

Description copied from interface: Driver

Sets the maximum varchar size.

Parameters:

value - the new maximum varchar size

setParentDriverName

public void setParentDriverName(String value)

Description copied from interface: Driver

Sets the parent driver class name.

Parameters:

value - the parent driver class name

supportsScripts

public boolean supportsScripts()

Description copied from interface: Driver

If true the database supports extended sql, such as PLSQL, Transact SQL, etc. Used by UI to disable/enable menu items.

Returns:

true, if database database supports extended sql

updateStagingBlob

public void updateStagingBlob(Connection conn,
                              Variable var,
                              String pkValue,
                              Object value)
                       throws Exception

Description copied from interface: Driver

Updates staging blob.

Parameters:

conn - the connection

var - the variable

pkValue - the primary key value

value - the value

Throws:

Exception - in case of any error

updateStagingClob

public void updateStagingClob(Connection conn,
                              Variable var,
                              String pkValue,
                              Object value)
                       throws Exception

Description copied from interface: Driver

Updates staging clob.

Parameters:

conn - the connection

var - the variable

pkValue - the primary key value

value - the value

Throws:

Exception - in case of any error

value2StorageValue

public Object value2StorageValue(int fieldType,
                                 Object value,
                                 Map<String,String> params,
                                 boolean booleanToNumber)

Description copied from interface: Driver

Converts value for storage.

Parameters:

fieldType - the field type Types

value - the value

params - the parameters

booleanToNumber - if true convert boolean true/false to 1/0

Returns:

the object

supportsIndexes

public boolean supportsIndexes()

Description copied from interface: Driver

Supports indexes.

Returns:

true, if database supports indexes