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

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

public class IndexLister
extends java.lang.Object

This interface gathers up some tasty information about the indices on a table from the DataDictionary.


Field Summary
private  long[] distinctIndexConglomerateNumbers
           
private  java.lang.String[] distinctIndexNames
           
private  IndexRowGenerator[] distinctIndexRowGenerators
           
private  long[] indexConglomerateNumbers
           
private  java.lang.String[] indexNames
           
private  IndexRowGenerator[] indexRowGenerators
           
private  TableDescriptor tableDescriptor
           
 
Constructor Summary
IndexLister(TableDescriptor tableDescriptor)
          Make an IndexLister
 
Method Summary
private  void getAllIndexes()
          Reads all the indices on the table and populates arrays with the corresponding index row generators and index conglomerate ids.
 long[] getDistinctIndexConglomerateNumbers()
          Returns an array of distinct index conglomerate ids on a table.
 java.lang.String[] getDistinctIndexNames()
          Returns an array of index names for all distinct indexes on a table.
 IndexRowGenerator[] getDistinctIndexRowGenerators()
          Returns an array of distinct index row generators on a table, erasing entries for duplicate indexes (which share same conglomerate).
 long[] getIndexConglomerateNumbers()
          Returns an array of all the index conglomerate ids on a table.
 java.lang.String[] getIndexNames()
          Returns an array of all the index names on a table.
 IndexRowGenerator[] getIndexRowGenerators()
          Returns an array of all the index row generators on a table.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tableDescriptor

private TableDescriptor tableDescriptor

indexRowGenerators

private IndexRowGenerator[] indexRowGenerators

indexConglomerateNumbers

private long[] indexConglomerateNumbers

indexNames

private java.lang.String[] indexNames

distinctIndexRowGenerators

private IndexRowGenerator[] distinctIndexRowGenerators

distinctIndexConglomerateNumbers

private long[] distinctIndexConglomerateNumbers

distinctIndexNames

private java.lang.String[] distinctIndexNames
Constructor Detail

IndexLister

public IndexLister(TableDescriptor tableDescriptor)
Make an IndexLister

Parameters:
tableDescriptor - Describes the table in question.
Method Detail

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

getIndexNames

public java.lang.String[] getIndexNames()
                                 throws StandardException
Returns an array of all the index names on a table.

Returns:
an array of index names
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 java.lang.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

Built on Thu 2010-12-23 20:49:13+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.