Class 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.
Version:
0.1
  • Field Details

    • indexId

      UUID indexId
      interface to this class:
      1. public UUID getIndexId();
      2. public ConglomerateDescriptor getIndexConglomerateDescriptor(DataDictionary dd)
      3. throws StandardException;
      4. public String getIndexUUIDString();
      5. public int[] getKeyColumns();
    • indexConglom

      private ConglomerateDescriptor indexConglom
  • Constructor Details

    • KeyConstraintDescriptor

      KeyConstraintDescriptor(DataDictionary dataDictionary, TableDescriptor table, String constraintName, boolean deferrable, boolean initiallyDeferred, int[] referencedColumns, UUID constraintId, UUID indexId, SchemaDescriptor schemaDesc, boolean enforced)
      Constructor for a KeyConstraintDescriptor
      Parameters:
      dataDictionary - The data dictionary that this descriptor lives in
      table - The descriptor of the table the constraint is on
      constraintName - The name of the constraint.
      deferrable - If the constraint can be deferred.
      initiallyDeferred - If the constraint starts life deferred.
      referencedColumns - columns that the constraint references
      constraintId - UUID of constraint
      indexId - The UUID for the backing index
      schemaDesc - The SchemaDescriptor for the constraint
      enforced - true if this constraint is enforced
  • Method Details

    • 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 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 String toString()
      Convert the SubConstraintDescriptor to a String.
      Overrides:
      toString in class ConstraintDescriptor
      Returns:
      A String representation of this SubConstraintDescriptor