SubConstraintDescriptor (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.iapi.sql.dictionary.TupleDescriptor
- - org.apache.derby.iapi.sql.dictionary.UniqueTupleDescriptor
  - - org.apache.derby.iapi.sql.dictionary.SubConstraintDescriptor

Direct Known Subclasses:

SubCheckConstraintDescriptor, SubKeyConstraintDescriptor
```
public abstract class SubConstraintDescriptor
extends 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

Field Summary

Fields
Modifier and Type	Field	Description
`(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();

Constructor Summary

Constructors
Constructor Description

SubConstraintDescriptor(UUID constraintId)
Constructor for a SubConstraintDescriptorImpl

Constructors
Constructor	Description
`SubConstraintDescriptor(UUID constraintId)`	Constructor for a SubConstraintDescriptorImpl

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class org.apache.derby.iapi.sql.dictionary.TupleDescriptor
getColumnDependableFinder, getDataDictionary, getDependableFinder, getDescriptorName, getDescriptorType, isPersistent, setDataDictionary

- 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
    
    Parameters:
    
    constraintId - The UUID of the constraint.
- Method Detail
  - setConstraintId
```
public void setConstraintId(UUID constraintId)
```
    Sets the UUID of the constraint.
    
    Parameters:
    
    constraintId - The constraint Id.
  - getUUID
```
public UUID getUUID()
```
    Gets the UUID of the constraint.
    
    Specified by:
    
    getUUID in class 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.
  - 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.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String representation of this SubConstraintDescriptor

Class SubConstraintDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

td

constraintId

Constructor Detail

SubConstraintDescriptor

Method Detail

setConstraintId

getUUID

hasBackingIndex

setTableDescriptor

getTableDescriptor

toString