|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.derby.iapi.sql.dictionary.TupleDescriptor
org.apache.derby.iapi.sql.dictionary.ConstraintDescriptor
org.apache.derby.iapi.sql.dictionary.KeyConstraintDescriptor
org.apache.derby.iapi.sql.dictionary.ForeignKeyConstraintDescriptor
public class ForeignKeyConstraintDescriptor
A foreign key.
Field Summary | |
---|---|
(package private) int |
raDeleteRule
|
(package private) int |
raUpdateRule
|
(package private) ReferencedKeyConstraintDescriptor |
referencedConstraintDescriptor
interface to this descriptor public ReferencedKeyConstraintDescriptor getReferencedConstraint() throws StandardException; public UUID getReferencedConstraintId() throws StandardException; public boolean isSelfReferencingFK() throws StandardException; |
(package private) UUID |
referencedConstraintId
|
Fields inherited from class org.apache.derby.iapi.sql.dictionary.KeyConstraintDescriptor |
---|
indexId |
Fields inherited from class org.apache.derby.iapi.sql.dictionary.ConstraintDescriptor |
---|
ALL, constraintId, constraintName, DISABLED, ENABLED, isEnabled, SYSCONSTRAINTS_STATE_FIELD, table |
Fields inherited from interface org.apache.derby.catalog.Dependable |
---|
ACTIVATION, ALIAS, COLUMNS_IN_TABLE, COLUMNS_PERMISSION, CONGLOMERATE, CONSTRAINT, DEFAULT, FILE, HEAP, INDEX, PERM, PREPARED_STATEMENT, ROLE_GRANT, ROUTINE_PERMISSION, SCHEMA, SEQUENCE, STORED_PREPARED_STATEMENT, TABLE, TABLE_PERMISSION, TRIGGER, VIEW |
Constructor Summary | |
---|---|
protected |
ForeignKeyConstraintDescriptor(DataDictionary dataDictionary,
TableDescriptor table,
java.lang.String constraintName,
boolean deferrable,
boolean initiallyDeferred,
int[] fkColumns,
UUID constraintId,
UUID indexId,
SchemaDescriptor schemaDesc,
ReferencedKeyConstraintDescriptor referencedConstraintDescriptor,
boolean isEnabled,
int raDeleteRule,
int raUpdateRule)
Constructor for a ForeignKeyConstraintDescriptor |
(package private) |
ForeignKeyConstraintDescriptor(DataDictionary dataDictionary,
TableDescriptor table,
java.lang.String constraintName,
boolean deferrable,
boolean initiallyDeferred,
int[] fkColumns,
UUID constraintId,
UUID indexId,
SchemaDescriptor schemaDesc,
UUID referencedConstraintId,
boolean isEnabled,
int raDeleteRule,
int raUpdateRule)
Constructor for a ForeignKeyConstraintDescriptor |
Method Summary | |
---|---|
int |
getConstraintType()
Gets an identifier telling what type of descriptor it is (UNIQUE, PRIMARY KEY, FOREIGN KEY, CHECK). |
int |
getRaDeleteRule()
Gets a referential action rule on a DELETE |
int |
getRaUpdateRule()
Gets a referential action rule on a UPDATE |
ReferencedKeyConstraintDescriptor |
getReferencedConstraint()
Get the constraint that this FK references. |
UUID |
getReferencedConstraintId()
Get the constraint id for the constraint that this FK references. |
boolean |
isSelfReferencingFK()
Am I a self-referencing FK? |
boolean |
needsToFire(int stmtType,
int[] modifiedCols)
Does this constraint need to fire on this type of DML? |
Methods inherited from class org.apache.derby.iapi.sql.dictionary.KeyConstraintDescriptor |
---|
getConglomerateId, getIndexConglomerateDescriptor, getIndexId, getIndexUUIDString, hasBackingIndex, toString |
Methods inherited from class org.apache.derby.iapi.sql.dictionary.ConstraintDescriptor |
---|
areColumnsComparable, columnIntersects, deferrable, doColumnsIntersect, drop, getClassType, getColumnDescriptors, getConstraintName, getConstraintText, getDependableFinder, getDescriptorName, getDescriptorType, getKeyColumns, getObjectID, getObjectName, getReferenceCount, getReferencedColumns, getSchemaDescriptor, getTableDescriptor, getTableId, getUUID, initiallyDeferred, isEnabled, isReferenced, isValid, makeInvalid, prepareToInvalidate, setDisabled, setEnabled |
Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor |
---|
getColumnDependableFinder, getDataDictionary, getDependableFinder, isPersistent, setDataDictionary |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.derby.catalog.Dependable |
---|
isPersistent |
Field Detail |
---|
ReferencedKeyConstraintDescriptor referencedConstraintDescriptor
UUID referencedConstraintId
int raDeleteRule
int raUpdateRule
Constructor Detail |
---|
protected ForeignKeyConstraintDescriptor(DataDictionary dataDictionary, TableDescriptor table, java.lang.String constraintName, boolean deferrable, boolean initiallyDeferred, int[] fkColumns, UUID constraintId, UUID indexId, SchemaDescriptor schemaDesc, ReferencedKeyConstraintDescriptor referencedConstraintDescriptor, boolean isEnabled, int raDeleteRule, int raUpdateRule)
dataDictionary
- The data dictionary that this descriptor lives intable
- The descriptor of the table the constraint is onconstraintName
- The name of the constraint.deferrable
- If the constraint can be deferred.initiallyDeferred
- If the constraint starts life deferred.fkColumns
- columns in the foreign keyconstraintId
- UUID of constraintindexId
- The UUID for the backing indexschemaDesc
- The SchemaDescriptor for the constraintreferencedConstraintDescriptor
- is referenced constraint descriptorisEnabled
- is the constraint enabled?ForeignKeyConstraintDescriptor(DataDictionary dataDictionary, TableDescriptor table, java.lang.String constraintName, boolean deferrable, boolean initiallyDeferred, int[] fkColumns, UUID constraintId, UUID indexId, SchemaDescriptor schemaDesc, UUID referencedConstraintId, boolean isEnabled, int raDeleteRule, int raUpdateRule)
dataDictionary
- The data dictionary that this descriptor lives intable
- The descriptor of the table the constraint is onconstraintName
- The name of the constraint.deferrable
- If the constraint can be deferred.initiallyDeferred
- If the constraint starts life deferred.fkColumns
- columns in the foreign keyconstraintId
- UUID of constraintindexId
- The UUID for the backing indexschemaDesc
- The SchemaDescriptor for the constraintreferencedConstraintId
- is referenced constraint idisEnabled
- is the constraint enabled?Method Detail |
---|
public ReferencedKeyConstraintDescriptor getReferencedConstraint() throws StandardException
StandardException
- on errorpublic UUID getReferencedConstraintId() throws StandardException
StandardException
- on errorpublic int getConstraintType()
getConstraintType
in class ConstraintDescriptor
public boolean needsToFire(int stmtType, int[] modifiedCols)
needsToFire
in class ConstraintDescriptor
stmtType
- the type of DML
(StatementType.INSERT|StatementType.UPDATE|StatementType.DELETE)modifiedCols
- the columns modified, or null for all
public boolean isSelfReferencingFK() throws StandardException
StandardException
- on errorpublic int getRaDeleteRule()
public int getRaUpdateRule()
|
Built on Thu 2010-12-23 20:49:13+0000, from revision ??? | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |