Package com.inductiveautomation.ignition.gateway.localdb

Class Table

java.lang.Object

com.inductiveautomation.ignition.gateway.localdb.Table

Direct Known Subclasses:

HsqlTable, SQLiteTable

public abstract class Table
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Table.Column
class	Table.ForeignKey
class	Table.PrimaryKey

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Table.Column>	columns
protected List<Table.ForeignKey>	fks
protected String	name	The name of the table
protected Table.PrimaryKey	pk
protected List<String>	sequences

Constructor Summary

Constructors

Constructor	Description
Table()

Method Summary

Modifier and Type	Method	Description
Table	buildFor(Table other)
Table	buildFor(String tableName, DataSource db)
Table	buildFor(SRecordMeta<? extends SRecordInstance> meta)
Table	buildNew(String name)
boolean	canAlterFrom(Table existingTable)	Returns true if all of the modifications required can be handled through altering.
String	colQC()
Table.Column	findColumn(String name)
protected abstract List<String>	findSequences(String tableName, Connection conn)
protected String	getColumnDdl(Table.Column col)
List<Table.Column>	getColumns()
protected String	getColumnTypeSql(SFieldScalar field)
List<String>	getConstraintDdl()
List<Table.ForeignKey>	getForeignKeys()
String	getIndexName(Table.Column column)
List<String>	getPhase1AlterDdl(Table existing)	Does all alter column statements
List<String>	getPhase1Transfer(Table originalTable)
List<String>	getPhase2AlterDdl(Table existing)	Does all constraint and sequence modification
List<String>	getPhase2Transfer(Table originalTable)
Table.PrimaryKey	getPrimaryKey()
String	getTableCreateDdl()
String	getTableName()
String	getTransferCommand(Table originalTable, String sourceName)
String	qc()
protected void	sqlDefinition_CreateForeignKeys(List<String> commands, List<Table.ForeignKey> fks)	Should create the sql for adding the foreign keys and add them to the "commands" list
protected String	sqlDefinition_CreateIndex(String indexName, String tableName, String columnName)
protected String	sqlDefinition_CreateSequence(String sequence, String table)	Returns the full "CREATE SEQUENCE seqName"
protected String	sqlDefinition_DropIndex(String indexName)
protected String	sqlDefinition_Table()	Returns the keyword(s) to use for create TABLE.
protected boolean	supportsConstraintModification()
protected boolean	supportsDropColumn()
boolean	tableExists()
protected String	valueToQueryLiteral(Object value, String columnType)
protected String	valueToQueryLiteral(Object value, SFieldScalar field)	In some cases, we put the value of the column directly into the query.

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

The name of the table

columns

protected List<Table.Column> columns

pk

protected Table.PrimaryKey pk

fks

protected List<Table.ForeignKey> fks

sequences

protected List<String> sequences

Constructor Details

Table

public Table()

Method Details

tableExists

public boolean tableExists()

buildFor

public Table buildFor(Table other)

buildFor

public Table buildFor(SRecordMeta<? extends SRecordInstance> meta)

buildFor

public Table buildFor(String tableName,
 DataSource db)
               throws SQLException

Throws:

SQLException

buildNew

public Table buildNew(String name)

colQC

public String colQC()

qc

public String qc()

canAlterFrom

public boolean canAlterFrom(Table existingTable)

Returns true if all of the modifications required can be handled through altering. If not, a new version of the table will be made.

supportsConstraintModification

protected boolean supportsConstraintModification()

getTransferCommand

public String getTransferCommand(Table originalTable,
 String sourceName)

findSequences

protected abstract List<String> findSequences(String tableName,
 Connection conn)
                                       throws SQLException

Throws:

SQLException

findColumn

public Table.Column findColumn(String name)

getTableName

public String getTableName()

getPhase1AlterDdl

public List<String> getPhase1AlterDdl(Table existing)

Does all alter column statements

getPhase2AlterDdl

public List<String> getPhase2AlterDdl(Table existing)

Does all constraint and sequence modification

sqlDefinition_Table

protected String sqlDefinition_Table()

Returns the keyword(s) to use for create TABLE. Default is "TABLE", but HSQL would use "CACHED TABLE"

sqlDefinition_CreateSequence

protected String sqlDefinition_CreateSequence(String sequence,
 String table)

Returns the full "CREATE SEQUENCE seqName"

sqlDefinition_CreateIndex

protected String sqlDefinition_CreateIndex(String indexName,
 String tableName,
 String columnName)

sqlDefinition_DropIndex

protected String sqlDefinition_DropIndex(String indexName)

supportsDropColumn

protected boolean supportsDropColumn()

getColumns

public List<Table.Column> getColumns()

getPrimaryKey

public Table.PrimaryKey getPrimaryKey()

getForeignKeys

public List<Table.ForeignKey> getForeignKeys()

getColumnDdl

protected String getColumnDdl(Table.Column col)

getTableCreateDdl

public String getTableCreateDdl()

getIndexName

public String getIndexName(Table.Column column)

getConstraintDdl

public List<String> getConstraintDdl()

sqlDefinition_CreateForeignKeys

protected void sqlDefinition_CreateForeignKeys(List<String> commands,
 List<Table.ForeignKey> fks)

Should create the sql for adding the foreign keys and add them to the "commands" list

getColumnTypeSql

protected String getColumnTypeSql(SFieldScalar field)

valueToQueryLiteral

protected String valueToQueryLiteral(Object value,
 SFieldScalar field)

In some cases, we put the value of the column directly into the query. This allows us to override how it is represented in the query.

valueToQueryLiteral

protected String valueToQueryLiteral(Object value,
 String columnType)

getPhase1Transfer

public List<String> getPhase1Transfer(Table originalTable)

getPhase2Transfer

public List<String> getPhase2Transfer(Table originalTable)