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

java.lang.Object
  extended byorg.apache.derby.iapi.sql.dictionary.TupleDescriptor
      extended byorg.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor
All Implemented Interfaces:
UniqueTupleDescriptor
Direct Known Subclasses:
SubCheckConstraintDescriptor, SubKeyConstraintDescriptor

public abstract class SubConstraintDescriptor
extends TupleDescriptor
implements UniqueTupleDescriptor

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
Author:
Jerry Brenner

Field Summary
(package private)  UUID constraintId
           
(package private)  TableDescriptor td
          public interface for this class: public void setConstraintId(UUID constraintId); public boolean hasBackingIndex(); public void setTableDescriptor(TableDescriptor td); public TableDescriptor getTableDescriptor();
 
Fields inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor
COLUMN_LIST, CONGLOMERATE_LIST, CONSTRAINT_LIST, TRIGGER_LIST
 
Constructor Summary
(package private) SubConstraintDescriptor(UUID constraintId)
          Constructor for a SubConstraintDescriptorImpl
 
Method Summary
 TableDescriptor getTableDescriptor()
          Returns the cached TableDescriptor, if supplied, that the constraint is on.
 UUID getUUID()
          Gets the UUID of the constraint.
abstract  boolean hasBackingIndex()
          Does this constraint have a backing index?
 void setConstraintId(UUID constraintId)
          Sets the UUID of the constraint.
 void setTableDescriptor(TableDescriptor td)
          Caches the TableDescriptor of the table that the constraint is on.
 java.lang.String toString()
          Convert the SubConstraintDescriptor to a String.
 
Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor
getColumnDependableFinder, getDataDictionary, getDependableFinder, getDescriptorName, getDescriptorType, isPersistent, setDataDictionary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

td

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();


constraintId

UUID constraintId
Constructor Detail

SubConstraintDescriptor

SubConstraintDescriptor(UUID constraintId)
Constructor for a SubConstraintDescriptorImpl

Method Detail

setConstraintId

public void setConstraintId(UUID constraintId)
Sets the UUID of the constraint.

Parameters:
constraintId - The constraint Id.
Returns:
Nothing.

getUUID

public UUID getUUID()
Gets the UUID of the constraint.

Specified by:
getUUID in interface UniqueTupleDescriptor
Returns:
The UUID of the constraint.

hasBackingIndex

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

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

setTableDescriptor

public void setTableDescriptor(TableDescriptor td)
Caches the TableDescriptor of the table that the constraint is on.

Parameters:
td - The TableDescriptor.
Returns:
Nothing.

getTableDescriptor

public TableDescriptor getTableDescriptor()
Returns the cached TableDescriptor, if supplied, that the constraint is on.

Returns:
The cached TableDescriptor, if supplied.

toString

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

Returns:
A String representation of this SubConstraintDescriptor

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.