Class IndexLister

java.lang.Object
org.apache.derby.iapi.sql.dictionary.IndexLister

public class IndexLister extends Object
This interface gathers up some tasty information about the indices on a table from the DataDictionary.
  • Field Details

    • tableDescriptor

      private TableDescriptor tableDescriptor
    • indexRowGenerators

      private IndexRowGenerator[] indexRowGenerators
    • indexConglomerateNumbers

      private long[] indexConglomerateNumbers
    • indexNames

      private String[] indexNames
    • distinctIndexRowGenerators

      private IndexRowGenerator[] distinctIndexRowGenerators
    • distinctIndexConglomerateNumbers

      private long[] distinctIndexConglomerateNumbers
    • distinctIndexNames

      private String[] distinctIndexNames
  • Constructor Details

    • IndexLister

      public IndexLister(TableDescriptor tableDescriptor)
      Make an IndexLister
      Parameters:
      tableDescriptor - Describes the table in question.
  • Method Details

    • getIndexRowGenerators

      public IndexRowGenerator[] getIndexRowGenerators() throws StandardException
      Returns an array of all the index row generators on a table.
      Returns:
      an array of index row generators
      Throws:
      StandardException - Thrown on error
    • getIndexConglomerateNumbers

      public long[] getIndexConglomerateNumbers() throws StandardException
      Returns an array of all the index conglomerate ids on a table.
      Returns:
      an array of index conglomerate ids
      Throws:
      StandardException - Thrown on error
    • getDistinctIndexRowGenerators

      public IndexRowGenerator[] getDistinctIndexRowGenerators() throws StandardException
      Returns an array of distinct index row generators on a table, erasing entries for duplicate indexes (which share same conglomerate).
      Returns:
      an array of index row generators
      Throws:
      StandardException - Thrown on error
    • getDistinctIndexConglomerateNumbers

      public long[] getDistinctIndexConglomerateNumbers() throws StandardException
      Returns an array of distinct index conglomerate ids on a table. erasing entries for duplicate indexes (which share same conglomerate).
      Returns:
      an array of index conglomerate ids
      Throws:
      StandardException - Thrown on error
    • getDistinctIndexNames

      public String[] getDistinctIndexNames() throws StandardException
      Returns an array of index names for all distinct indexes on a table. erasing entries for duplicate indexes (which share same conglomerate).
      Returns:
      an array of index names
      Throws:
      StandardException - Thrown on error
    • getAllIndexes

      private void getAllIndexes() throws StandardException
      Reads all the indices on the table and populates arrays with the corresponding index row generators and index conglomerate ids.
      Throws:
      StandardException - Thrown on error