Modifier and Type	Class and Description
pack-priv static class	Constraint.ConstraintCore This class consists of the data structure for a Constraint.

Modifier and Type	Field and Description
pack-priv Expression	check
pack-priv int	constType
pack-priv Constraint.ConstraintCore	core
public static final Constraint[]	emptyArray Hides org.hsqldb.SchemaObject.emptyArray.
pack-priv boolean	isForward
private boolean	isNotNull
pack-priv boolean	isSimpleIdentityPK
pack-priv OrderedHashSet<String>	mainColSet
private HsqlNameManager.HsqlName	name
pack-priv int	notNullColumnIndex
pack-priv RangeVariable	rangeVariable
pack-priv OrderedHashSet<String>	refColSet

Access	Constructor and Description
private	Constraint()
public	Constraint(HsqlNameManager.HsqlName name, Table t, Index index, int type) Constructor declaration for PK and UNIQUE
public	Constraint(HsqlNameManager.HsqlName name, Table table, int[] cols, int type)
public	Constraint(HsqlNameManager.HsqlName name, Constraint fkconstraint) Constructor for main constraints (foreign key references in PK table)
public	Constraint(HsqlNameManager.HsqlName name of constraint name, HsqlNameManager.HsqlName refTableName, OrderedHashSet<String> list of referencing columns refCols, HsqlNameManager.HsqlName referenced table mainTableName, OrderedHashSet<String> list of referenced columns mainCols, int constraint type type, int triggered action on delete deleteAction, int triggered action on update updateAction, int matchType) General constructor for foreign key constraints.
public	Constraint(HsqlNameManager.HsqlName name, OrderedHashSet<String> mainCols, int type)
public	Constraint(HsqlNameManager.HsqlName uniqueName, HsqlNameManager.HsqlName mainName, HsqlNameManager.HsqlName refName, Table mainTable, Table refTable, int[] mainCols, int[] refCols, Index mainIndex, Index refIndex, int deleteAction, int updateAction)

Method Summary

Modifier and Type	Method and Description
pack-priv void	checkCheckConstraint(Session session, Table table, Object[] data)
pack-priv void	checkCheckConstraint(Session session, Table table, ColumnSchema column, Object data)
pack-priv void	checkCheckConstraint(Session session, Table table)
pack-priv void	checkInsert(Session session, Table table, Object[] data, Object[] oldData) Checks for foreign key or check constraint violation when inserting a row into the child table.
pack-priv void	checkReferencedRows(Session session, Table table) Check used before creating a new foreign key cosntraint, this method checks all rows of a table to ensure they all have a corresponding row in the main table.
pack-priv Constraint	duplicate()
public void	extendFKIndexColumns(Session session, int[] colIndexExt)
pack-priv RowIterator	Returns: iterator findFkRef(Session Session session, Object[] array of objects for a database row row) New method to find any referencing row for a foreign key (finds row in child table).
pack-priv RowIterator	findUniqueRows(Session session, Object[] row) Finds a row matching the values in UNIQUE columns.
private static String	getActionString(int action) Returns the foreign key action rule.
public String	getAlterSQL()
public HsqlNameManager.HsqlName	getCatalogName() Implements org.hsqldb.SchemaObject.getCatalogName.
public long	getChangeTimestamp() Implements org.hsqldb.SchemaObject.getChangeTimestamp.
public OrderedHashSet<Expression>	getCheckColumnExpressions()
public Expression	getCheckExpression()
public String	getCheckSQL() Returns the SQL for the expression in CHECK clause
public int	getConstraintType() Returns the type of constraint
public int	getDeferability()
public int	getDeleteAction() The ON DELETE triggered action of (foreign key) constraint
public String	getDeleteActionString()
public HsqlException	getException(Object[] data)
private void	getFKStatement(StringBuilder sb) Generates the foreign key declaration for a given Constraint object.
public Table	getMain() Returns the main table
public int[]	getMainColumns() Returns the main table column index array
public Index	getMainIndex() Returns the main index
public HsqlNameManager.HsqlName	getMainName()
public HsqlNameManager.HsqlName	getMainTableName()
public HsqlNameManager.HsqlName	getName() Implements org.hsqldb.SchemaObject.getName. Returns the HsqlName.
private Expression	getNewCheckExpression(Session session)
public Grantee	getOwner() Implements org.hsqldb.SchemaObject.getOwner.
public Table	getRef() Returns the reference table
public int[]	getRefColumns() Returns the reference table column index array
public OrderedHashSet<HsqlNameManager.HsqlName>	getReferences() Overrides default org.hsqldb.SchemaObject.getReferences.
public Index	getRefIndex() Returns the reference index
public HsqlNameManager.HsqlName	getRefName()
public HsqlNameManager.HsqlName	getSchemaName() Implements org.hsqldb.SchemaObject.getSchemaName.
public String	getSQL() Implements org.hsqldb.SchemaObject.getSQL.
public int	getType() Implements org.hsqldb.SchemaObject.getType.
public HsqlNameManager.HsqlName	getUniqueName()
public int	getUpdateAction() The ON UPDATE triggered action of (foreign key) constraint
public String	getUpdateActionString()
pack-priv boolean	hasColumn(int colIndex)
pack-priv boolean	hasColumnOnly(int colIndex)
pack-priv boolean	hasColumnPlus(int colIndex)
public boolean	hasCoreTriggeredAction()
public boolean	hasTriggeredAction()
pack-priv boolean	isEquivalent(Table mainTable, int[] mainCols, Table refTable, int[] refCols) Compares this with another constraint column set.
public boolean	isNotNull() Returns true if the expression in CHECK is a simple IS NOT NULL
public boolean	isUniqueOrPK()
pack-priv boolean	isUniqueWithColumns(int[] cols) Compares this with another constraint column set.
pack-priv void	prepareCheckConstraint(Session session, Table table)
pack-priv void	prepareDomainCheckConstraint(Session session)
pack-priv void	recompile(Session session, Table newTable)
pack-priv void	setColumnsIndexes(Table table)
pack-priv void	setSimpleIdentityPK()
pack-priv void	updateTable(Session Session session, Table reference to the old version of the table oldTable, Table reference to the new version of the table newTable, int[] indexes at which table column is added or removed colIndex, int -1, 0, +1 to indicate if column is added or removed adjust) Used to update constrains to reflect structural changes in a table.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

check	back to summary
pack-priv Expression check

constType	back to summary
pack-priv int constType

core	back to summary
pack-priv Constraint.ConstraintCore core

emptyArray	back to summary
public static final Constraint[] emptyArray Hides org.hsqldb.SchemaObject.emptyArray.

isForward	back to summary
pack-priv boolean isForward

isNotNull	back to summary
private boolean isNotNull

isSimpleIdentityPK	back to summary
pack-priv boolean isSimpleIdentityPK

mainColSet	back to summary
pack-priv OrderedHashSet<String> mainColSet

name	back to summary
private HsqlNameManager.HsqlName name

notNullColumnIndex	back to summary
pack-priv int notNullColumnIndex

rangeVariable	back to summary
pack-priv RangeVariable rangeVariable

refColSet	back to summary
pack-priv OrderedHashSet<String> refColSet

Constructor Detail

Constraint	back to summary
private Constraint()

Constraint	back to summary
public Constraint(HsqlNameManager.HsqlName name, Table t, Index index, int type) Constructor declaration for PK and UNIQUE

Constraint	back to summary
public Constraint(HsqlNameManager.HsqlName name, Table table, int[] cols, int type)

Constraint	back to summary
public Constraint(HsqlNameManager.HsqlName name, Constraint fkconstraint) Constructor for main constraints (foreign key references in PK table)

Constraint	back to summary
public Constraint(HsqlNameManager.HsqlName name, HsqlNameManager.HsqlName refTableName, OrderedHashSet<String> refCols, HsqlNameManager.HsqlName mainTableName, OrderedHashSet<String> mainCols, int type, int deleteAction, int updateAction, int matchType) General constructor for foreign key constraints. Parameters name:HsqlNameManager.HsqlName name of constraint refCols:OrderedHashSet<String> list of referencing columns mainTableName:HsqlNameManager.HsqlName referenced table mainCols:OrderedHashSet<String> list of referenced columns type:int constraint type deleteAction:int triggered action on delete updateAction:int triggered action on update

Constraint

back to summary

public Constraint(HsqlNameManager.HsqlName name, HsqlNameManager.HsqlName refTableName, OrderedHashSet<String> refCols, HsqlNameManager.HsqlName mainTableName, OrderedHashSet<String> mainCols, int type, int deleteAction, int updateAction, int matchType)

General constructor for foreign key constraints.

Parameters

name:HsqlNameManager.HsqlName: name of constraint
refCols:OrderedHashSet<String>: list of referencing columns
mainTableName:HsqlNameManager.HsqlName: referenced table
mainCols:OrderedHashSet<String>: list of referenced columns
type:int: constraint type
deleteAction:int: triggered action on delete
updateAction:int: triggered action on update

Constraint	back to summary
public Constraint(HsqlNameManager.HsqlName name, OrderedHashSet<String> mainCols, int type)

Constraint	back to summary
public Constraint(HsqlNameManager.HsqlName uniqueName, HsqlNameManager.HsqlName mainName, HsqlNameManager.HsqlName refName, Table mainTable, Table refTable, int[] mainCols, int[] refCols, Index mainIndex, Index refIndex, int deleteAction, int updateAction)

Method Detail

checkCheckConstraint	back to summary
pack-priv void checkCheckConstraint(Session session, Table table, Object[] data)

checkCheckConstraint	back to summary
pack-priv void checkCheckConstraint(Session session, Table table, ColumnSchema column, Object data)

checkCheckConstraint	back to summary
pack-priv void checkCheckConstraint(Session session, Table table)

checkInsert	back to summary
pack-priv void checkInsert(Session session, Table table, Object[] data, Object[] oldData) Checks for foreign key or check constraint violation when inserting a row into the child table.

checkReferencedRows	back to summary
pack-priv void checkReferencedRows(Session session, Table table) Check used before creating a new foreign key cosntraint, this method checks all rows of a table to ensure they all have a corresponding row in the main table.

duplicate	back to summary
pack-priv Constraint duplicate()

extendFKIndexColumns	back to summary
public void extendFKIndexColumns(Session session, int[] colIndexExt)

findFkRef	back to summary
pack-priv RowIterator findFkRef(Session session, Object[] row) New method to find any referencing row for a foreign key (finds row in child table). If ON DELETE CASCADE is specified for this constraint, then the method finds the first row among the rows of the table ordered by the index and doesn't throw. Without ON DELETE CASCADE, the method attempts to find any row that exists. If no row is found, null is returned. (fredt@users) Parameters session:Session Session row:Object[] array of objects for a database row Returns:RowIterator iterator

findFkRef

back to summary

pack-priv RowIterator findFkRef(Session session, Object[] row)

New method to find any referencing row for a foreign key (finds row in child table). If ON DELETE CASCADE is specified for this constraint, then the method finds the first row among the rows of the table ordered by the index and doesn't throw. Without ON DELETE CASCADE, the method attempts to find any row that exists. If no row is found, null is returned. (fredt@users)

Parameters

session:Session: Session
row:Object[]: array of objects for a database row

Returns:RowIterator

iterator

findUniqueRows	back to summary
pack-priv RowIterator findUniqueRows(Session session, Object[] row) Finds a row matching the values in UNIQUE columns.

getActionString	back to summary
private static String getActionString(int action) Returns the foreign key action rule.

getAlterSQL	back to summary
public String getAlterSQL()

getCatalogName	back to summary
public HsqlNameManager.HsqlName getCatalogName() Implements org.hsqldb.SchemaObject.getCatalogName.

getChangeTimestamp	back to summary
public long getChangeTimestamp() Implements org.hsqldb.SchemaObject.getChangeTimestamp.

getCheckColumnExpressions	back to summary
public OrderedHashSet<Expression> getCheckColumnExpressions()

getCheckExpression	back to summary
public Expression getCheckExpression()

getCheckSQL	back to summary
public String getCheckSQL() Returns the SQL for the expression in CHECK clause

getConstraintType	back to summary
public int getConstraintType() Returns the type of constraint

getDeferability	back to summary
public int getDeferability()

getDeleteAction	back to summary
public int getDeleteAction() The ON DELETE triggered action of (foreign key) constraint

getDeleteActionString	back to summary
public String getDeleteActionString()

getException	back to summary
public HsqlException getException(Object[] data)

getFKStatement	back to summary
private void getFKStatement(StringBuilder sb) Generates the foreign key declaration for a given Constraint object.

getMain	back to summary
public Table getMain() Returns the main table

getMainColumns	back to summary
public int[] getMainColumns() Returns the main table column index array

getMainIndex	back to summary
public Index getMainIndex() Returns the main index

getMainName	back to summary
public HsqlNameManager.HsqlName getMainName()

getMainTableName	back to summary
public HsqlNameManager.HsqlName getMainTableName()

getName

back to summary

public HsqlNameManager.HsqlName getName()

Implements org.hsqldb.SchemaObject.getName.

Returns the HsqlName.

getNewCheckExpression	back to summary
private Expression getNewCheckExpression(Session session)

getOwner	back to summary
public Grantee getOwner() Implements org.hsqldb.SchemaObject.getOwner.

getRef	back to summary
public Table getRef() Returns the reference table

getRefColumns	back to summary
public int[] getRefColumns() Returns the reference table column index array

getReferences	back to summary
public OrderedHashSet<HsqlNameManager.HsqlName> getReferences() Overrides default org.hsqldb.SchemaObject.getReferences.

getRefIndex	back to summary
public Index getRefIndex() Returns the reference index

getRefName	back to summary
public HsqlNameManager.HsqlName getRefName()

getSchemaName	back to summary
public HsqlNameManager.HsqlName getSchemaName() Implements org.hsqldb.SchemaObject.getSchemaName.

getSQL	back to summary
public String getSQL() Implements org.hsqldb.SchemaObject.getSQL.

getType	back to summary
public int getType() Implements org.hsqldb.SchemaObject.getType.

getUniqueName	back to summary
public HsqlNameManager.HsqlName getUniqueName()

getUpdateAction	back to summary
public int getUpdateAction() The ON UPDATE triggered action of (foreign key) constraint

getUpdateActionString	back to summary
public String getUpdateActionString()

hasColumn	back to summary
pack-priv boolean hasColumn(int colIndex)

hasColumnOnly	back to summary
pack-priv boolean hasColumnOnly(int colIndex)

hasColumnPlus	back to summary
pack-priv boolean hasColumnPlus(int colIndex)

hasCoreTriggeredAction	back to summary
public boolean hasCoreTriggeredAction()

hasTriggeredAction	back to summary
public boolean hasTriggeredAction()

isEquivalent	back to summary
pack-priv boolean isEquivalent(Table mainTable, int[] mainCols, Table refTable, int[] refCols) Compares this with another constraint column set. This implementation only checks FOREIGN KEY constraints.

isNotNull	back to summary
public boolean isNotNull() Returns true if the expression in CHECK is a simple IS NOT NULL

isUniqueOrPK	back to summary
public boolean isUniqueOrPK()

isUniqueWithColumns	back to summary
pack-priv boolean isUniqueWithColumns(int[] cols) Compares this with another constraint column set. This is used only for UNIQUE constraints.

prepareCheckConstraint	back to summary
pack-priv void prepareCheckConstraint(Session session, Table table)

prepareDomainCheckConstraint	back to summary
pack-priv void prepareDomainCheckConstraint(Session session)

recompile	back to summary
pack-priv void recompile(Session session, Table newTable)

setColumnsIndexes	back to summary
pack-priv void setColumnsIndexes(Table table)

setSimpleIdentityPK	back to summary
pack-priv void setSimpleIdentityPK()

updateTable

back to summary

pack-priv void updateTable(Session session, Table oldTable, Table newTable, int[] colIndex, int adjust)

Used to update constrains to reflect structural changes in a table. Prior checks must ensure that this method does not throw.

Parameters

session:Session: Session
oldTable:Table: reference to the old version of the table
newTable:Table: reference to the new version of the table
colIndex:int[]: indexes at which table column is added or removed
adjust:int: -1, 0, +1 to indicate if column is added or removed

org.hsqldb back to summary

pack-priv Class Constraint.ConstraintCore

Class Inheritance

extends Object

java.lang.Object
org.hsqldb.Constraint.ConstraintCore

This class consists of the data structure for a Constraint. This structure is shared between two Constraint Objects that together form a foreign key constraint. This simplifies structural modifications to a table. When changes to the column indexes are applied to the table's Constraint Objects, they are reflected in the Constraint Objects of any other table that shares a foreign key constraint with the modified table.

Author: Fred Toussi (fredt@users dot sourceforge.net)
Since: 1.7.1
Version: 1.9.0

Field Summary

Modifier and Type	Field and Description
pack-priv int[]	addedRefCols
pack-priv int	deleteAction
pack-priv boolean	hasDeleteAction
pack-priv boolean	hasUpdateAction
pack-priv int[]	mainCols
pack-priv Index	mainIndex
pack-priv HsqlNameManager.HsqlName	mainName
pack-priv Table	mainTable
pack-priv HsqlNameManager.HsqlName	mainTableName
pack-priv int	matchType
pack-priv int[]	refCols
pack-priv Index	refIndex
pack-priv HsqlNameManager.HsqlName	refName
pack-priv Table	refTable
pack-priv HsqlNameManager.HsqlName	refTableName
pack-priv HsqlNameManager.HsqlName	uniqueName
pack-priv int	updateAction

Constructor Summary

Access	Constructor and Description
pack-priv	ConstraintCore()

Method Summary

Modifier and Type	Method and Description
pack-priv Constraint.ConstraintCore	duplicate()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

addedRefCols	back to summary
pack-priv int[] addedRefCols

deleteAction	back to summary
pack-priv int deleteAction

hasDeleteAction	back to summary
pack-priv boolean hasDeleteAction

hasUpdateAction	back to summary
pack-priv boolean hasUpdateAction

mainCols	back to summary
pack-priv int[] mainCols

mainIndex	back to summary
pack-priv Index mainIndex

mainName	back to summary
pack-priv HsqlNameManager.HsqlName mainName

mainTable	back to summary
pack-priv Table mainTable

mainTableName	back to summary
pack-priv HsqlNameManager.HsqlName mainTableName

matchType	back to summary
pack-priv int matchType

refCols	back to summary
pack-priv int[] refCols

refIndex	back to summary
pack-priv Index refIndex

refName	back to summary
pack-priv HsqlNameManager.HsqlName refName

refTable	back to summary
pack-priv Table refTable

refTableName	back to summary
pack-priv HsqlNameManager.HsqlName refTableName

uniqueName	back to summary
pack-priv HsqlNameManager.HsqlName uniqueName

updateAction	back to summary
pack-priv int updateAction

Constructor Detail

ConstraintCore	back to summary
pack-priv ConstraintCore()

Method Detail

duplicate	back to summary
pack-priv Constraint.ConstraintCore duplicate()

public final Class Constraint

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Constraint.ConstraintCore

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail