Top Description Fields Constructors Methods
org.apache.derby.iapi.sql.dictionary

public abstract Class SubConstraintDescriptor

extends UniqueTupleDescriptor
Class Inheritance
Known Direct Subclasses
org.apache.derby.iapi.sql.dictionary.SubKeyConstraintDescriptor, org.apache.derby.iapi.sql.dictionary.SubCheckConstraintDescriptor
Imports
org.apache.derby.catalog.UUID, org.apache.derby.shared.common.sanity.SanityManager
This interface is used to get information from a SubConstraintDescriptor. A SubKeyConstraintDescriptor is used within the DataDictionary to get auxiliary constraint information from the system table that is auxiliary to sysconstraints.
Version
0.1

Field Summary

Modifier and TypeField and Description
pack-priv UUID
constraintId

pack-priv TableDescriptor
td

public interface for this class:

  1. public void setConstraintId(UUID constraintId);
  2. public boolean hasBackingIndex();
  3. public void setTableDescriptor(TableDescriptor td);
  4. public TableDescriptor getTableDescriptor();

Constructor Summary

AccessConstructor and Description
pack-priv
SubConstraintDescriptor(UUID
The UUID of the constraint.
constraintId)

Constructor for a SubConstraintDescriptorImpl

Method Summary

Modifier and TypeMethod and Description
public TableDescriptor

Returns:

The cached TableDescriptor, if supplied.
getTableDescriptor()

Returns the cached TableDescriptor, if supplied, that the constraint is on.

public UUID

Returns:

The UUID of the constraint.
getUUID()

Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor.getUUID.

Gets the UUID of the constraint.

public abstract boolean

Returns:

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

Does this constraint have a backing index?

public void
setConstraintId(UUID
The constraint Id.
constraintId)

Sets the UUID of the constraint.

public void
setTableDescriptor(TableDescriptor
The TableDescriptor.
td)

Caches the TableDescriptor of the table that the constraint is on.

public String

Returns:

A String representation of this SubConstraintDescriptor
toString()

Overrides java.lang.Object.toString.

Convert the SubConstraintDescriptor to a String.

Field Detail

constraintIdback to summary
pack-priv UUID constraintId
tdback to summary
pack-priv TableDescriptor td

public interface for this class:

  1. public void setConstraintId(UUID constraintId);
  2. public boolean hasBackingIndex();
  3. public void setTableDescriptor(TableDescriptor td);
  4. public TableDescriptor getTableDescriptor();

Constructor Detail

SubConstraintDescriptorback to summary
pack-priv SubConstraintDescriptor(UUID constraintId)

Constructor for a SubConstraintDescriptorImpl

Parameters
constraintId:UUID

The UUID of the constraint.

Method Detail

getTableDescriptorback to summary
public TableDescriptor getTableDescriptor()

Returns the cached TableDescriptor, if supplied, that the constraint is on.

Returns:TableDescriptor

The cached TableDescriptor, if supplied.

getUUIDback to summary
public UUID getUUID()

Implements abstract org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor.getUUID.

Gets the UUID of the constraint.

Returns:UUID

The UUID of the constraint.

hasBackingIndexback to summary
public abstract boolean hasBackingIndex()

Does this constraint have a backing index?

Returns:boolean

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

setConstraintIdback to summary
public void setConstraintId(UUID constraintId)

Sets the UUID of the constraint.

Parameters
constraintId:UUID

The constraint Id.

setTableDescriptorback to summary
public void setTableDescriptor(TableDescriptor td)

Caches the TableDescriptor of the table that the constraint is on.

Parameters
td:TableDescriptor

The TableDescriptor.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Convert the SubConstraintDescriptor to a String.

Returns:String

A String representation of this SubConstraintDescriptor