org.apache.derby.iapi.sql.dictionary
Class CheckConstraintDescriptor

java.lang.Object
  extended byorg.apache.derby.iapi.sql.dictionary.TupleDescriptor
      extended byorg.apache.derby.iapi.sql.dictionary.ConstraintDescriptor
          extended byorg.apache.derby.iapi.sql.dictionary.CheckConstraintDescriptor
All Implemented Interfaces:
Dependable, Dependent, Provider, UniqueTupleDescriptor

public class CheckConstraintDescriptor
extends ConstraintDescriptor

This class represents a check constraint descriptor.

Author:
jamie

Field Summary
(package private)  java.lang.String constraintText
           
(package private)  ReferencedColumns referencedColumns
           
 
Fields inherited from class org.apache.derby.iapi.sql.dictionary.ConstraintDescriptor
ALL, colDL, constraintId, constraintName, deferrable, DISABLED, ENABLED, initiallyDeferred, isEnabled, schemaDesc, SYSCONSTRAINTS_STATE_FIELD, table
 
Fields inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor
COLUMN_LIST, CONGLOMERATE_LIST, CONSTRAINT_LIST, TRIGGER_LIST
 
Fields inherited from interface org.apache.derby.catalog.Dependable
ALIAS, COLUMNS_IN_TABLE, CONGLOMERATE, CONSTRAINT, DEFAULT, FILE, HEAP, INDEX, PREPARED_STATEMENT, SCHEMA, STORED_PREPARED_STATEMENT, TABLE, TRIGGER, VIEW
 
Constructor Summary
(package private) CheckConstraintDescriptor(DataDictionary dataDictionary, TableDescriptor table, java.lang.String constraintName, boolean deferrable, boolean initiallyDeferred, UUID constraintId, java.lang.String constraintText, ReferencedColumns referencedColumns, SchemaDescriptor schemaDesc, boolean isEnabled)
           
 
Method Summary
 UUID getConglomerateId()
          Get the UUID of the backing index, if one exists.
 java.lang.String getConstraintText()
          Get the text of the constraint.
 int getConstraintType()
          Gets an identifier telling what type of descriptor it is (UNIQUE, PRIMARY KEY, FOREIGN KEY, CHECK).
 int[] getReferencedColumns()
          Get the referenced columns as an int[] of column ids.
 ReferencedColumns getReferencedColumnsDescriptor()
          Get the ReferencedColumns.
 boolean hasBackingIndex()
          Does this constraint have a backing index?
 boolean needsToFire(int stmtType, int[] modifiedCols)
          Does this constraint need to fire on this type of DML?
 void setReferencedColumnsDescriptor(ReferencedColumns rcd)
          Set the ReferencedColumns; used in drop column
 java.lang.String toString()
          Convert the CheckConstraintDescriptor to a String.
 
Methods inherited from class org.apache.derby.iapi.sql.dictionary.ConstraintDescriptor
areColumnsComparable, columnIntersects, deferrable, doColumnsIntersect, getClassType, getColumnDescriptors, getConstraintName, getDependableFinder, getDescriptorName, getDescriptorType, getKeyColumns, getObjectID, getObjectName, getReferenceCount, getSchemaDescriptor, getTableDescriptor, getTableId, getUUID, initiallyDeferred, isEnabled, isReferenced, isValid, makeInvalid, makeValid, prepareToInvalidate, setConstraintId, 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

referencedColumns

ReferencedColumns referencedColumns

constraintText

java.lang.String constraintText
Constructor Detail

CheckConstraintDescriptor

CheckConstraintDescriptor(DataDictionary dataDictionary,
                          TableDescriptor table,
                          java.lang.String constraintName,
                          boolean deferrable,
                          boolean initiallyDeferred,
                          UUID constraintId,
                          java.lang.String constraintText,
                          ReferencedColumns referencedColumns,
                          SchemaDescriptor schemaDesc,
                          boolean isEnabled)
Method Detail

hasBackingIndex

public boolean hasBackingIndex()
Does this constraint have a backing index?

Specified by:
hasBackingIndex in class ConstraintDescriptor
Returns:
boolean Whether or not there is a backing index for this constraint.

getConstraintType

public int getConstraintType()
Gets an identifier telling what type of descriptor it is (UNIQUE, PRIMARY KEY, FOREIGN KEY, CHECK).

Specified by:
getConstraintType in class ConstraintDescriptor
Returns:
An identifier telling what type of descriptor it is (UNIQUE, PRIMARY KEY, FOREIGN KEY, CHECK).

getConstraintText

public java.lang.String getConstraintText()
Get the text of the constraint. (Only non-null/meaningful for check constraints.)

Overrides:
getConstraintText in class ConstraintDescriptor
Returns:
The constraint text.

getConglomerateId

public UUID getConglomerateId()
Get the UUID of the backing index, if one exists.

Specified by:
getConglomerateId in class ConstraintDescriptor
Returns:
The UUID of the backing index, if one exists, else null.

getReferencedColumnsDescriptor

public ReferencedColumns getReferencedColumnsDescriptor()
Get the ReferencedColumns.

Returns:
The ReferencedColumns.

setReferencedColumnsDescriptor

public void setReferencedColumnsDescriptor(ReferencedColumns rcd)
Set the ReferencedColumns; used in drop column

Returns:
void

getReferencedColumns

public int[] getReferencedColumns()
Get the referenced columns as an int[] of column ids.

Overrides:
getReferencedColumns in class ConstraintDescriptor
Returns:
The array of referenced column ids.

needsToFire

public boolean needsToFire(int stmtType,
                           int[] modifiedCols)
Does this constraint need to fire on this type of DML? For a check constraint, all inserts, and appropriate updates

Specified by:
needsToFire in class ConstraintDescriptor
Parameters:
modifiedCols - the columns modified, or null for all
Returns:
true/false

toString

public java.lang.String toString()
Convert the CheckConstraintDescriptor to a String.

Overrides:
toString in class ConstraintDescriptor
Returns:
A String representation of this CheckConstraintDescriptor

Built on Tue 2006-10-10 19:23:47+0200, from revision exported

Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.