org.apache.derby.iapi.sql.dictionary

Class KeyConstraintDescriptor

java.lang.Object

org.apache.derby.iapi.sql.dictionary.TupleDescriptor

org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor

org.apache.derby.iapi.sql.dictionary.ConstraintDescriptor

org.apache.derby.iapi.sql.dictionary.KeyConstraintDescriptor

All Implemented Interfaces:

Dependable, Dependent, Provider

Direct Known Subclasses:

ForeignKeyConstraintDescriptor, ReferencedKeyConstraintDescriptor

public abstract class KeyConstraintDescriptor
extends ConstraintDescriptor

This interface is used to get information from a KeyConstraintDescriptor. A KeyConstraintDescriptor can represent a primary/unique/foreign key constraint.

Field Summary

Fields inherited from class org.apache.derby.iapi.sql.dictionary.ConstraintDescriptor

ALL, DISABLED, ENABLED, SYSCONSTRAINTS_STATE_FIELD

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

Method Summary

Modifier and Type	Method and Description
UUID	getConglomerateId() Get the UUID of the backing index, if one exists.
ConglomerateDescriptor	getIndexConglomerateDescriptor(DataDictionary dd) Gets the index conglomerate descriptor
UUID	getIndexId() Gets the UUID of the backing index for the constraint.
java.lang.String	getIndexUUIDString() Gets the UUID String of the backing index for the constraint.
boolean	hasBackingIndex() Does this constraint have a backing index?
java.lang.String	toString() Convert the SubConstraintDescriptor to a String.

Methods inherited from class org.apache.derby.iapi.sql.dictionary.ConstraintDescriptor

areColumnsComparable, columnIntersects, deferrable, drop, enforced, getClassType, getColumnDescriptors, getConstraintName, getConstraintText, getConstraintType, getDependableFinder, getDescriptorName, getDescriptorType, getKeyColumns, getObjectID, getObjectName, getReferenceCount, getReferencedColumns, getSchemaDescriptor, getTableDescriptor, getTableId, getUUID, initiallyDeferred, isReferenced, isValid, makeInvalid, needsToFire, prepareToInvalidate, setDeferrable, setEnforced, setInitiallyDeferred

Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor

isPersistent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.derby.catalog.Dependable

isPersistent

Method Detail

getIndexId

public UUID getIndexId()

Gets the UUID of the backing index for the constraint.

Returns:

The UUID of the backing index for the constraint.

getIndexConglomerateDescriptor

public ConglomerateDescriptor getIndexConglomerateDescriptor(DataDictionary dd)
                                                      throws StandardException

Gets the index conglomerate descriptor

Returns:

the index conglomerate descriptor

Throws:

StandardException - on error

getIndexUUIDString

public java.lang.String getIndexUUIDString()

Gets the UUID String of the backing index for the constraint.

Returns:

The UUID String of the backing index for the constraint.

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.

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.

toString

public java.lang.String toString()

Convert the SubConstraintDescriptor to a String.

Overrides:

toString in class ConstraintDescriptor

Returns:

A String representation of this SubConstraintDescriptor