org.hsqldb

Class Constraint

java.lang.Object

org.hsqldb.Constraint

All Implemented Interfaces:

SchemaObject

public final class Constraint
extends java.lang.Object
implements SchemaObject

Implementation of a table constraint with references to the indexes used by the constraint.

Since:

1.6.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.hsqldb.SchemaObject

SchemaObject.ConstraintTypes, SchemaObject.Deferable, SchemaObject.Nullability, SchemaObject.ParameterModes, SchemaObject.ReferentialAction, SchemaObject.ViewCheckModes

Field Summary

Fields

Modifier and Type	Field and Description
static Constraint[]	emptyArray

Fields inherited from interface org.hsqldb.SchemaObject

ASSERTION, CATALOG, CHARSET, COLLATION, COLUMN, CONSTRAINT, CURSOR, DOMAIN, FUNCTION, GRANTEE, INDEX, LABEL, PARAMETER, PROCEDURE, ROUTINE, SCHEMA, SEARCH, SEQUENCE, SERVER, SPECIFIC_ROUTINE, SUBQUERY, TABLE, TRANSITION, TRIGGER, TYPE, VARIABLE, VIEW, WRAPPER

Constructor Summary

Constructors

Constructor and Description
Constraint(HsqlNameManager.HsqlName name, Constraint fkconstraint) Constructor for main constraints (foreign key references in PK table)
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)
Constraint(HsqlNameManager.HsqlName name, HsqlNameManager.HsqlName refTableName, OrderedHashSet refCols, HsqlNameManager.HsqlName mainTableName, OrderedHashSet mainCols, int type, int deleteAction, int updateAction, int matchType) General constructor for foreign key constraints.
Constraint(HsqlNameManager.HsqlName name, OrderedHashSet mainCols, int type)
Constraint(HsqlNameManager.HsqlName name, Table t, Index index, int type) Constructor declaration for PK and UNIQUE
Constraint(HsqlNameManager.HsqlName name, Table table, int[] cols, int type)

Method Summary

Modifier and Type	Method and Description
void	compile(Session session, SchemaObject parentObject)
HsqlNameManager.HsqlName	getCatalogName()
long	getChangeTimestamp()
OrderedHashSet	getCheckColumnExpressions()
Expression	getCheckExpression()
java.lang.String	getCheckSQL() Returns the SQL for the expression in CHECK clause
OrderedHashSet	getComponents()
int	getConstraintType() Returns the type of constraint
int	getDeferability()
int	getDeleteAction() The ON DELETE triggered action of (foreign key) constraint
java.lang.String	getDeleteActionString()
HsqlException	getException(java.lang.Object[] data)
Table	getMain() Returns the main table
int[]	getMainColumns() Returns the main table column index array
HsqlNameManager.HsqlName	getMainName()
HsqlNameManager.HsqlName	getMainTableName()
HsqlNameManager.HsqlName	getName() Returns the HsqlName.
Grantee	getOwner()
Table	getRef() Returns the reference table
int[]	getRefColumns() Returns the reference table column index array
OrderedHashSet	getReferences()
HsqlNameManager.HsqlName	getRefName()
HsqlNameManager.HsqlName	getSchemaName()
java.lang.String	getSQL()
int	getType()
HsqlNameManager.HsqlName	getUniqueName()
int	getUpdateAction() The ON UPDATE triggered action of (foreign key) constraint
java.lang.String	getUpdateActionString()
boolean	hasTriggeredAction()
boolean	isNotNull() Returns true if the expression in CHECK is a simple IS NOT NULL

Methods inherited from class java.lang.Object

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

Field Detail

emptyArray

public static final Constraint[] emptyArray

Constructor Detail

Constraint

public Constraint(HsqlNameManager.HsqlName name,
                  Table t,
                  Index index,
                  int type)

Constructor declaration for PK and UNIQUE

Constraint

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

Constraint

public Constraint(HsqlNameManager.HsqlName name,
                  Constraint fkconstraint)

Constructor for main constraints (foreign key references in PK table)

Constraint

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

General constructor for foreign key constraints.

Parameters:

name - name of constraint

refCols - list of referencing columns

mainTableName - referenced table

mainCols - list of referenced columns

type - constraint type

deleteAction - triggered action on delete

updateAction - triggered action on update

Constraint

public Constraint(HsqlNameManager.HsqlName name,
                  OrderedHashSet mainCols,
                  int type)

Constraint

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)
           throws HsqlException

Throws:

HsqlException

Method Detail

getType

public int getType()

Specified by:

getType in interface SchemaObject

getName

public HsqlNameManager.HsqlName getName()

Returns the HsqlName.

Specified by:

getName in interface SchemaObject

getCatalogName

public HsqlNameManager.HsqlName getCatalogName()

Specified by:

getCatalogName in interface SchemaObject

getSchemaName

public HsqlNameManager.HsqlName getSchemaName()

Specified by:

getSchemaName in interface SchemaObject

getOwner

public Grantee getOwner()

Specified by:

getOwner in interface SchemaObject

getReferences

public OrderedHashSet getReferences()

Specified by:

getReferences in interface SchemaObject

getComponents

public OrderedHashSet getComponents()

Specified by:

getComponents in interface SchemaObject

compile

public void compile(Session session,
                    SchemaObject parentObject)

Specified by:

compile in interface SchemaObject

getSQL

public java.lang.String getSQL()

Specified by:

getSQL in interface SchemaObject

getChangeTimestamp

public long getChangeTimestamp()

Specified by:

getChangeTimestamp in interface SchemaObject

getMainTableName

public HsqlNameManager.HsqlName getMainTableName()

getMainName

public HsqlNameManager.HsqlName getMainName()

getRefName

public HsqlNameManager.HsqlName getRefName()

getUniqueName

public HsqlNameManager.HsqlName getUniqueName()

getConstraintType

public int getConstraintType()

Returns the type of constraint

getMain

public Table getMain()

Returns the main table

getRef

public Table getRef()

Returns the reference table

getDeleteAction

public int getDeleteAction()

The ON DELETE triggered action of (foreign key) constraint

getDeleteActionString

public java.lang.String getDeleteActionString()

getUpdateAction

public int getUpdateAction()

The ON UPDATE triggered action of (foreign key) constraint

getUpdateActionString

public java.lang.String getUpdateActionString()

hasTriggeredAction

public boolean hasTriggeredAction()

getDeferability

public int getDeferability()

getMainColumns

public int[] getMainColumns()

Returns the main table column index array

getRefColumns

public int[] getRefColumns()

Returns the reference table column index array

getCheckSQL

public java.lang.String getCheckSQL()

Returns the SQL for the expression in CHECK clause

isNotNull

public boolean isNotNull()

Returns true if the expression in CHECK is a simple IS NOT NULL

getException

public HsqlException getException(java.lang.Object[] data)

getCheckExpression

public Expression getCheckExpression()

getCheckColumnExpressions

public OrderedHashSet getCheckColumnExpressions()