org.apache.derby.impl.sql.catalog
Class IndexInfoImpl

java.lang.Object
  extended byorg.apache.derby.impl.sql.catalog.IndexInfoImpl

public class IndexInfoImpl
extends java.lang.Object

A poor mans structure used in DataDictionaryImpl.java. Used to save information about system indexes.

Author:
jerry

Field Summary
(package private)  int columnCount
           
(package private)  java.lang.String[] columnNames
           
(package private)  int[] columnPositions
           
(package private)  long conglomerateNumber
           
(package private)  IndexRowGenerator irg
           
(package private)  boolean isUnique
           
(package private)  java.lang.String name
           
 
Constructor Summary
(package private) IndexInfoImpl(long conglomerateNumber, java.lang.String indexName, int columnCount, boolean isUnique, int indexNumber, CatalogRowFactory crf)
          Constructor
 
Method Summary
 int getBaseColumnPosition(int colNumber)
          Get the base column position for a column within a catalog given the (0-based) column number for the column within the index.
 int getColumnCount()
          Get the column count for the index.
 long getConglomerateNumber()
          Get the conglomerate number for the index.
 java.lang.String getIndexName()
          Get the index name for the index.
 IndexRowGenerator getIndexRowGenerator()
          Get the IndexRowGenerator for this index.
 boolean isIndexUnique()
          Return whether or not this index is declared unique
 void setBaseColumnPosition(int colNumber, int baseColumnPosition)
          Set the base column position for a column within a catalog given the (0-based) column number for the column within the index.
 void setConglomerateNumber(long conglomerateNumber)
          Set the conglomerate number for the index.
 void setIndexName(java.lang.String indexName)
          Set the name for the index.
 void setIndexRowGenerator(IndexRowGenerator irg)
          Set the IndexRowGenerator for this index.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

isUnique

boolean isUnique

columnNames

java.lang.String[] columnNames

columnPositions

int[] columnPositions

irg

IndexRowGenerator irg

columnCount

int columnCount

conglomerateNumber

long conglomerateNumber

name

java.lang.String name
Constructor Detail

IndexInfoImpl

IndexInfoImpl(long conglomerateNumber,
              java.lang.String indexName,
              int columnCount,
              boolean isUnique,
              int indexNumber,
              CatalogRowFactory crf)
Constructor

Parameters:
conglomerateNumber - The conglomerate number for the index
indexName - The name of the index
columnCount - The number of columns in the index
isUnique - Whether or not the index was declared as unique
indexNumber - (0-based) number of index within catalog's indexes
crf - CatalogRowFactory for the catalog
Method Detail

getConglomerateNumber

public long getConglomerateNumber()
Get the conglomerate number for the index.

Returns:
long The conglomerate number for the index.

setConglomerateNumber

public void setConglomerateNumber(long conglomerateNumber)
Set the conglomerate number for the index.

Parameters:
conglomerateNumber - The conglomerateNumber for the index.
Returns:
Nothing.

getIndexName

public java.lang.String getIndexName()
Get the index name for the index.

Returns:
String The index name for the index.

setIndexName

public void setIndexName(java.lang.String indexName)
Set the name for the index.

Parameters:
indexName - The name for the index.
Returns:
Nothing.

getColumnCount

public int getColumnCount()
Get the column count for the index.

Returns:
int The column count for the index.

getIndexRowGenerator

public IndexRowGenerator getIndexRowGenerator()
Get the IndexRowGenerator for this index.

Returns:
IndexRowGenerator The IRG for this index.

setIndexRowGenerator

public void setIndexRowGenerator(IndexRowGenerator irg)
Set the IndexRowGenerator for this index.

Parameters:
irg - The IndexRowGenerator for this index.
Returns:
Nothing.

getBaseColumnPosition

public int getBaseColumnPosition(int colNumber)
Get the base column position for a column within a catalog given the (0-based) column number for the column within the index.

Parameters:
colNumber - The column number within the index
Returns:
int The base column position for the column.

setBaseColumnPosition

public void setBaseColumnPosition(int colNumber,
                                  int baseColumnPosition)
Set the base column position for a column within a catalog given the (0-based) column number for the column within the index.

Parameters:
colNumber - The column number within the index
Returns:
Nothing.

isIndexUnique

public boolean isIndexUnique()
Return whether or not this index is declared unique

Returns:
boolean Whether or not this index is declared unique

Built on Mon 2007-06-04 09:58:47+0400, from revision ???

Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.