Package com.inductiveautomation.ignition.gateway.db.schema

Class DBTableSchema

java.lang.Object

com.inductiveautomation.ignition.gateway.db.schema.DBTableSchema

public class DBTableSchema
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
DBTableSchema(java.lang.String tableName)
DBTableSchema(java.lang.String tableName, DBTranslator translator)

Method Summary

Modifier and Type	Method	Description
void	addColumnsToTable(java.sql.Connection conn, ColumnList columns)
void	addRequiredColumn(Column value)
void	addRequiredColumn(java.lang.String name, DataType type)
void	addRequiredColumn(java.lang.String name, DataType type, java.util.EnumSet<ColumnProperty> properties)
void	createTable(java.sql.Connection conn)
java.lang.String	getCasedColumnName(java.lang.String column)	Returns the given column name, but with the casing retrieved from the database.
protected org.apache.log4j.Logger	getLogger()
java.lang.String	getTableName()
void	insertRequiredColumn(java.lang.String name, DataType type, java.util.EnumSet<ColumnProperty> properties)
TableState	refreshTableState(java.sql.Connection conn)
void	setTranslator(DBTranslator value)
void	verifyAndUpdate(java.sql.Connection conn)

Methods inherited from class java.lang.Object

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

Constructor Detail

DBTableSchema

public DBTableSchema(java.lang.String tableName)

DBTableSchema

public DBTableSchema(java.lang.String tableName,
                     DBTranslator translator)

Method Detail

getLogger

protected org.apache.log4j.Logger getLogger()

getCasedColumnName

public java.lang.String getCasedColumnName(java.lang.String column)

Returns the given column name, but with the casing retrieved from the database. If not available, the input is returned.

setTranslator

public void setTranslator(DBTranslator value)

getTableName

public java.lang.String getTableName()

addRequiredColumn

public void addRequiredColumn(java.lang.String name,
                              DataType type)

addRequiredColumn

public void addRequiredColumn(java.lang.String name,
                              DataType type,
                              java.util.EnumSet<ColumnProperty> properties)

addRequiredColumn

public void addRequiredColumn(Column value)

insertRequiredColumn

public void insertRequiredColumn(java.lang.String name,
                                 DataType type,
                                 java.util.EnumSet<ColumnProperty> properties)

verifyAndUpdate

public void verifyAndUpdate(java.sql.Connection conn)
                     throws java.lang.Exception

Throws:

java.lang.Exception

createTable

public void createTable(java.sql.Connection conn)
                 throws java.lang.Exception

Throws:

java.lang.Exception

addColumnsToTable

public void addColumnsToTable(java.sql.Connection conn,
                              ColumnList columns)
                       throws java.lang.Exception

Throws:

java.lang.Exception

refreshTableState

public TableState refreshTableState(java.sql.Connection conn)
                             throws java.lang.Exception

Throws:

java.lang.Exception