org.apache.derby.iapi.sql.dictionary

Class SubKeyConstraintDescriptor

java.lang.Object

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

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

org.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor

org.apache.derby.iapi.sql.dictionary.SubKeyConstraintDescriptor

public class SubKeyConstraintDescriptor
extends SubConstraintDescriptor

This interface is used to get information from a SubKeyConstraintDescriptor. A SubKeyConstraintDescriptor is used within the DataDictionary to get auxiliary constraint information from the system table that is auxiliary to sysconstraints.

Constructor Summary

Constructors

Constructor and Description
SubKeyConstraintDescriptor(UUID constraintId, UUID indexId) Constructor for a SubConstraintDescriptorImpl
SubKeyConstraintDescriptor(UUID constraintId, UUID indexId, UUID keyConstraintId) Constructor for a SubConstraintDescriptor
SubKeyConstraintDescriptor(UUID constraintId, UUID indexId, UUID keyConstraintId, int raDeleteRule, int raUpdateRule) Constructor for a SubConstraintDescriptor

Method Summary

Modifier and Type	Method and Description
UUID	getIndexId() Gets the UUID of the backing index.
UUID	getKeyConstraintId() Gets the UUID of the referenced key constraint
int	getRaDeleteRule() Gets a referential action rule on a DELETE
int	getRaUpdateRule() Gets a referential action rule on a UPDATE
boolean	hasBackingIndex() Does this constraint have a backing index?
java.lang.String	toString() Convert the SubKeyConstraintDescriptor to a String.

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

getTableDescriptor, getUUID, setConstraintId, setTableDescriptor

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

getDescriptorName, getDescriptorType, isPersistent

Methods inherited from class java.lang.Object

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

Constructor Detail

SubKeyConstraintDescriptor

public SubKeyConstraintDescriptor(UUID constraintId,
                                  UUID indexId)

Constructor for a SubConstraintDescriptorImpl

Parameters:

constraintId - The UUID of the constraint.

indexId - The UUID of the backing index.

SubKeyConstraintDescriptor

public SubKeyConstraintDescriptor(UUID constraintId,
                                  UUID indexId,
                                  UUID keyConstraintId)

Constructor for a SubConstraintDescriptor

Parameters:

constraintId - The UUID of the constraint.

indexId - The UUID of the backing index.

keyConstraintId - The UUID of the referenced constraint (fks)

SubKeyConstraintDescriptor

public SubKeyConstraintDescriptor(UUID constraintId,
                                  UUID indexId,
                                  UUID keyConstraintId,
                                  int raDeleteRule,
                                  int raUpdateRule)

Constructor for a SubConstraintDescriptor

Parameters:

constraintId - The UUID of the constraint.

indexId - The UUID of the backing index.

keyConstraintId - The UUID of the referenced constraint (fks)

raDeleteRule - The referential action for delete

raUpdateRule - The referential action for update

Method Detail

getIndexId

public UUID getIndexId()

Gets the UUID of the backing index.

Returns:

The UUID of the backing index.

getKeyConstraintId

public UUID getKeyConstraintId()

Gets the UUID of the referenced key constraint

Returns:

The UUID of the referenced key constraint

hasBackingIndex

public boolean hasBackingIndex()

Does this constraint have a backing index?

Specified by:

hasBackingIndex in class SubConstraintDescriptor

Returns:

boolean Whether or not there is a backing index for this constraint.

getRaDeleteRule

public int getRaDeleteRule()

Gets a referential action rule on a DELETE

Returns:

referential rule defined by the user during foreign key creattion for a delete (like CASCDE , RESTRICT ..etc)

getRaUpdateRule

public int getRaUpdateRule()

Gets a referential action rule on a UPDATE

Returns:

referential rule defined by the user during foreign key creattion for an UPDATE (like CASCDE , RESTRICT ..etc)

toString

public java.lang.String toString()

Convert the SubKeyConstraintDescriptor to a String.

Overrides:

toString in class SubConstraintDescriptor

Returns:

A String representation of this SubConstraintDescriptor