com.toolsverse.etl.driver

Class GenericFileDriver

Object

com.toolsverse.etl.driver.AbstractDriver

com.toolsverse.etl.driver.SimpleDriver

com.toolsverse.etl.driver.GenericFileDriver

All Implemented Interfaces:

Driver, ExtensionModule, Serializable, Comparable<ExtensionModule>

Direct Known Subclasses:

GenericFileDriverNoMetadataOnWrite

public class GenericFileDriver
extends SimpleDriver

Default ETL driver for the file based data sources, such as text files, xml files, Excel etc.

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

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

DEF_FUNCTION_CLASS, END_ON_EXCEPTION, ON_EXCEPTION

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
GenericFileDriver()

Method Summary

Modifier and Type	Method and Description
String	convertStringForStorage(String value) Converts string so it can be used as s part of sql.
String	convertValueForStorage(Object fieldValue, int fieldType, boolean isFromTable) Converts value to string depending on fieldType so it can be used as s part of sql.
String	getCmdForExternalTool(ObjectStorage storage, Alias alias, String sqlFile) Gets the command line for the external tool.
Object	getExplainPlan(ObjectStorage storage, Connection connection, Alias alias, String sql) Gets the explain plan for the sql.
String	getExternalToolName() Gets the external tool name.
String	getIconPath() Gets the full path to the icon file.
String	getJdbcDriverClassName() Gets the jdbc driver class name.
String	getMetadataClassName() Gets the metadata driver class name.
String	getName() Gets the name of the driver.
String	getPropsWizardResource(String connectionDriver) Gets the name of the xml file used to create a wizard for editing properties.
String	getSqlForExternalTool(Alias alias, String sql, SqlParser parser) Gets the sql for external tool.
String	getTableName(String name) Gets the table name.
String	getUrlPattern() Gets the jdbc driver url pattern.
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[]	supportedJoinTypes() Returns supported join types, such as inner join, left outer join etc.
String[]	supportedSetOperations() Returns names of the supported set operations, such as union, union all, etc.
boolean	supportsIndexes() Supports indexes.
boolean	supportsParallelExtract() "Supports parallel extract" flag.
boolean	supportsParallelLoad() "Supports parallel load" flag.
boolean	supportsScripts() If true the database supports extended sql, such as PLSQL, Transact SQL, etc.
Object	value2StorageValue(int fieldType, Object value, Map<String,String> params, boolean booleanToNumber) Converts value for storage.

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

deleteStagingBinary, filter, getAddColumnSql, getAlterTableAddColumnSql, getBegin, getBeginSplited, getBlob, getCallSql, getCharUsedForColumnsWithSpaces, getClob, getCreateTableSql, getCursorLoopEndSql, getCursorLoopStartSql, getCursorRecAccessSql, getDeclare, getDeclareCursorEndSql, getDeclareCursorSql, getDeclareCursorVarSql, getDefaultFunctionClass, getDefaultType, getDelimiter, getDestinationInfo, getDropSql, getEnd, getEndSplited, getIf, getIfBegin, getIfElse, getIfEnd, getInitSql, getLinesLimit, getMaxCharSize, getMaxPrecision, getMaxScale, getMaxStringLiteralSize, getMaxVarcharSize, getMergeStatement, getMetadataSelectClause, getMetadataWhereClause, getObject, getOnException, getOnExceptionBegin, getOnExceptionEnd, getParamType, getParentDriver, getParentDriverName, getPrecision, getSafeDelimiter, getTempTableName, getTopSelectClause, getTopTrailClause, getTopWhereClause, getType, getVarDeclare, getVarName, getWrongScale, ignoreExceptionsDuringInit, isMergeInNonCallableSupported, needSeparateConnectionForDdl, replaceOnException, requiresRollbackAfterSqlError, setBlob, setClob, setInitSql, setLinesLimit, setMaxCharSize, setMaxPrecision, setMaxScale, setMaxStringLiteralSize, setMaxVarcharSize, setParentDriverName, supportsAnonymousBlocks, supportsBinaryInProc, supportsCallableStatement, supportsExplainPlan, supportsExternalTool, supportsInnerFunctions, supportsParamsInAnonymousBlocks, supportsRollbackAfterDDL, updateStagingBlob, updateStagingClob

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

alwaysEncloseTableAndColumnsInQuotes, captureLog, compareTo, externalToolRequiresRedirect, getAllowedIdentifierChars, getAlterTableAddColumnSql, getAutotrace, getCaseSensitive, getCmdOptions, getColumns, getConfigFileName, getConnectionFile, getDefaultNull, getDeleteStatement, getDisplayName, getErrorLinePattern, getExtensionRank, getHome, getIdentifierName, getIdentifierName, getInsertStatement, getLicensePropertyName, getLocalUnitClassPath, getNativeType, getObjectCheckSql, getPostDeclareSql, getProperties, getSafeSql, getSelectStatement, getSqlForAutotrace, getSqlForExplainPlan, getSqlKeywordsFileName, getStartTransactionSql, getStringFieldSizeMultiplier, getTablePrefixWhenAddingTable, getType, getUpdateStatement, isEqualDriver, requiresExecuteQuery, requiresSeparateConnectionForIndexes, setAlwaysEncloseTableAndColumnsInQuotes, setCaseSensitive, setStringFieldSizeMultiplier, setUpConnection, supportColonInFormatter, supportsAutotrace, supportsLogging, supportsNotNullable, 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

disableMetadataOnWrite, getIoProcessorClassName, ifDoesNotExistSql, ifExistsSql, openCloseConnectionOnDdl, requiresSemicolonInMerge

Constructor Detail

GenericFileDriver

public GenericFileDriver()

Method Detail

convertStringForStorage

public String convertStringForStorage(String value)

Description copied from interface: Driver

Converts string so it can be used as s part of sql. Typically adds "'". Example abc -> 'abc'

Specified by:

convertStringForStorage in interface Driver

Overrides:

convertStringForStorage in class SimpleDriver

Parameters:

value - the value

Returns:

the string

convertValueForStorage

public String convertValueForStorage(Object fieldValue,
                                     int fieldType,
                                     boolean isFromTable)

Description copied from interface: Driver

Converts value to string depending on fieldType so it can be used as s part of sql.

Specified by:

convertValueForStorage in interface Driver

Overrides:

convertValueForStorage in class SimpleDriver

Parameters:

fieldValue - the field value

fieldType - the field type Types}

isFromTable - if true the value is coming from result set, otherwise - from the database cursor

Returns:

the string

getCmdForExternalTool

public String getCmdForExternalTool(ObjectStorage storage,
                                    Alias alias,
                                    String sqlFile)

Description copied from interface: Driver

Gets the command line for the external tool.

Parameters:

storage - the object storage

alias - the alias

sqlFile - the sql file

Returns:

the command line for the external tool

See Also:

ObjectStorage

getExplainPlan

public Object getExplainPlan(ObjectStorage storage,
                             Connection connection,
                             Alias alias,
                             String sql)

Description copied from interface: Driver

Gets the explain plan for the sql.

Parameters:

storage - the object storage

connection - the connection

alias - the alias

sql - the sql

Returns:

the explain plan

See Also:

ObjectStorage

getExternalToolName

public String getExternalToolName()

Description copied from interface: Driver

Gets the external tool name.

Returns:

the external tool name

getIconPath

public String getIconPath()

Description copied from interface: ExtensionModule

Gets the full path to the icon file. The icon reside inside package and deployed with the code in jar file.

Returns:

the icon path

getJdbcDriverClassName

public String getJdbcDriverClassName()

Description copied from interface: Driver

Gets the jdbc driver class name.

Returns:

the jdbc driver class name

getMetadataClassName

public String getMetadataClassName()

Description copied from interface: Driver

Gets the metadata driver class name.

Returns:

the metadata driver class name

getName

public String getName()

Description copied from interface: Driver

Gets the name of the driver.

Returns:

the name of the driver

getPropsWizardResource

public String getPropsWizardResource(String connectionDriver)

Description copied from interface: Driver

Gets the name of the xml file used to create a wizard for editing properties.

Parameters:

connectionDriver - the connection driver

Returns:

the name of the xml file

getSqlForExternalTool

public String getSqlForExternalTool(Alias alias,
                                    String sql,
                                    SqlParser parser)

Description copied from interface: Driver

Gets the sql for external tool.

Parameters:

alias - the alias

sql - the original sql

parser - the sql parser

Returns:

the sql for the external tool

getTableName

public String getTableName(String name)

Description copied from interface: Driver

Gets the table name.

Specified by:

getTableName in interface Driver

Overrides:

getTableName in class AbstractDriver

Parameters:

name - the name

Returns:

the table name

getUrlPattern

public String getUrlPattern()

Description copied from interface: Driver

Gets the jdbc driver url pattern.

Returns:

the jdbc driver url pattern

getVendor

public String getVendor()

Description copied from interface: ExtensionModule

Gets the vendor.

Returns:

the vendor

getVersion

public String getVersion()

Description copied from interface: ExtensionModule

Gets the version of the extension module.

Returns:

the version

getXmlConfigFileName

public String getXmlConfigFileName()

Description copied from interface: ExtensionModule

Gets the path to the xml configuration file for the module. The xml configuration file usually contains module specific UI elements, resides inside package and deployed with the code in the jar file.

Returns:

the path to the configuration name

supportedJoinTypes

public String[] supportedJoinTypes()

Description copied from interface: Driver

Returns supported join types, such as inner join, left outer join etc.

Returns:

the supported join types

supportedSetOperations

public String[] supportedSetOperations()

Description copied from interface: Driver

Returns names of the supported set operations, such as union, union all, etc.

Returns:

the names of the supported set operations

supportsParallelExtract

public boolean supportsParallelExtract()

Description copied from interface: Driver

"Supports parallel extract" flag.

Specified by:

supportsParallelExtract in interface Driver

Overrides:

supportsParallelExtract in class AbstractDriver

Returns:

true, if driver supports parallel extract

supportsParallelLoad

public boolean supportsParallelLoad()

Description copied from interface: Driver

"Supports parallel load" flag.

Specified by:

supportsParallelLoad in interface Driver

Overrides:

supportsParallelLoad in class AbstractDriver

Returns:

true, if driver supports parallel load

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

supportsIndexes

public boolean supportsIndexes()

Description copied from interface: Driver

Supports indexes.

Returns:

true, if database supports indexes

value2StorageValue

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

Description copied from interface: Driver

Converts value for storage.

Specified by:

value2StorageValue in interface Driver

Overrides:

value2StorageValue in class SimpleDriver

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