Package com.inductiveautomation.ignition.gateway.db

Class DefaultDBTranslator

java.lang.Object

com.inductiveautomation.ignition.gateway.db.DefaultDBTranslator

All Implemented Interfaces:

DBTranslator

public class DefaultDBTranslator
extends Object
implements DBTranslator

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.db.DBTranslator

DBTranslator.Tokens

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alterColumnDef
protected String	alterTable
protected String	autoIncTypeDef
protected String	columnQuoteChar
protected String	createAISequence
protected String	createAITrigger
protected String	createIndex
protected String	createTable
protected String	currentTimeQuery
protected String	limitDef
protected LimitPosition	limitPos
protected int	maxIdentifierLength
protected String	primaryKeyDef
protected String	readGKQuery
protected boolean	supportsRgk
protected String	tableListFilter
protected EnumMap<DataType,String>	typeMap

Constructor Summary

Constructors

Constructor	Description
DefaultDBTranslator()
DefaultDBTranslator(String cTable, String cAISeq, String cAITrig, String cNdx, String autoInc, String lDef, LimitPosition lPos, String aTable, String aTableColumn, String pKey, String qCurTime, EnumMap<DataType,String> tMap, String colQuoteChar, boolean supportsRgk, String fetchRgkQuery, String tableListFilter)
DefaultDBTranslator(EnumMap<DataType,String> tMap)

Method Summary

Modifier and Type	Method	Description
String	applyLimit(String query, Integer limit)	Takes a SELECT query and applies the given limit to it, resulting in a select query with a limiting clause.
protected EnumMap<DataType,String>	createTypeMap()
List<String>	getAlterCommand(String tableName, ColumnList columns)
String	getColumnQuoteChar()	Returns the character that this driver uses to quote names in queries
List<String>	getCreateCommand(String tableName, ColumnList columns)
String	getCreateIndexCommand(String tableName, Column column)
protected String	getCreationDef(ColumnList columns)
String	getCurrentTimeQuery()	Returns a query that can be used to get the current database time.
protected String	getDataTypeKeyword(DataType type)
String	getFetchKeyQuery(String tableName, String columnName)	A query to be executed instead of using JDBC's built-in facility for obtaining auto-generated keys.
protected String	getShortendName(String name)
protected String	getSpecialtyDef(String tokenVal, String definition, String token)
String	getTableListFilter()	Returns a filter that will be used to narrow the list of tables returned from the database.
boolean	isSupportsRGK()
String	quoteColumn(Column col)
String	quoteColumn(String col)
protected String	replaceToken(String source, String token, String value)
protected String	replaceTokens(String source, List<String> tokens, List<String> value)

Methods inherited from class java.lang.Object

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

Field Details

createTable

protected String createTable

createAISequence

protected String createAISequence

createAITrigger

protected String createAITrigger

createIndex

protected String createIndex

autoIncTypeDef

protected String autoIncTypeDef

limitDef

protected String limitDef

limitPos

protected LimitPosition limitPos

alterTable

protected String alterTable

alterColumnDef

protected String alterColumnDef

primaryKeyDef

protected String primaryKeyDef

currentTimeQuery

protected String currentTimeQuery

columnQuoteChar

protected String columnQuoteChar

supportsRgk

protected boolean supportsRgk

readGKQuery

protected String readGKQuery

tableListFilter

protected String tableListFilter

maxIdentifierLength

protected int maxIdentifierLength

typeMap

protected EnumMap<DataType,String> typeMap

Constructor Details

DefaultDBTranslator

public DefaultDBTranslator()

DefaultDBTranslator

public DefaultDBTranslator(EnumMap<DataType,String> tMap)

DefaultDBTranslator

public DefaultDBTranslator(String cTable,
 String cAISeq,
 String cAITrig,
 String cNdx,
 String autoInc,
 String lDef,
 LimitPosition lPos,
 String aTable,
 String aTableColumn,
 String pKey,
 String qCurTime,
 EnumMap<DataType,String> tMap,
 String colQuoteChar,
 boolean supportsRgk,
 String fetchRgkQuery,
 String tableListFilter)

Method Details

createTypeMap

protected EnumMap<DataType,String> createTypeMap()

getCurrentTimeQuery

public String getCurrentTimeQuery()

Description copied from interface: DBTranslator

Returns a query that can be used to get the current database time.

Specified by:

getCurrentTimeQuery in interface DBTranslator

quoteColumn

public String quoteColumn(Column col)

quoteColumn

public String quoteColumn(String col)

getCreateCommand

public List<String> getCreateCommand(String tableName,
 ColumnList columns)

Specified by:

getCreateCommand in interface DBTranslator

applyLimit

public String applyLimit(String query,
 Integer limit)

Description copied from interface: DBTranslator

Takes a SELECT query and applies the given limit to it, resulting in a select query with a limiting clause. If the incoming query already has a limit clause, the existing text will be used (that is, nothing further will be done).

Specified by:

applyLimit in interface DBTranslator

getAlterCommand

public List<String> getAlterCommand(String tableName,
 ColumnList columns)

Specified by:

getAlterCommand in interface DBTranslator

getCreateIndexCommand

public String getCreateIndexCommand(String tableName,
 Column column)

Specified by:

getCreateIndexCommand in interface DBTranslator

getShortendName

protected String getShortendName(String name)

getCreationDef

protected String getCreationDef(ColumnList columns)

getSpecialtyDef

protected String getSpecialtyDef(String tokenVal,
 String definition,
 String token)

replaceToken

protected String replaceToken(String source,
 String token,
 String value)

replaceTokens

protected String replaceTokens(String source,
 List<String> tokens,
 List<String> value)

getDataTypeKeyword

protected String getDataTypeKeyword(DataType type)

getColumnQuoteChar

public String getColumnQuoteChar()

Description copied from interface: DBTranslator

Returns the character that this driver uses to quote names in queries

Specified by:

getColumnQuoteChar in interface DBTranslator

getFetchKeyQuery

public String getFetchKeyQuery(String tableName,
 String columnName)

Description copied from interface: DBTranslator

A query to be executed instead of using JDBC's built-in facility for obtaining auto-generated keys. Only used if supportsRGK is false. Takes the table name and column name in case the query needs to use them- it will depend on the database as to whether or not they are.

Specified by:

getFetchKeyQuery in interface DBTranslator

isSupportsRGK

public boolean isSupportsRGK()

Specified by:

isSupportsRGK in interface DBTranslator

Returns:

whether or not this driver supports returning generated keys on insert queries

getTableListFilter

public String getTableListFilter()

Description copied from interface: DBTranslator

Returns a filter that will be used to narrow the list of tables returned from the database. A semi-colon separated list of simple patterns, like "apex_*;sys_info*"

Specified by:

getTableListFilter in interface DBTranslator