Top Description Fields Constructors Methods
org.apache.derby.impl.sql.catalog

pack-priv Class IndexInfoImpl

extends Object
Class Inheritance
Imports
org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.sql.dictionary.CatalogRowFactory, .ConglomerateDescriptor, .IndexRowGenerator, org.apache.derby.catalog.UUID
A poor mans structure used in DataDictionaryImpl.java. Used to save information about system indexes.

Field Summary

Modifier and TypeField and Description
private long
conglomerateNumber

private final CatalogRowFactory
crf

private final int
indexNumber

private IndexRowGenerator
irg

Constructor Summary

AccessConstructor and Description
pack-priv
IndexInfoImpl(int
(0-based) number of index within catalog's indexes
indexNumber, CatalogRowFactory
CatalogRowFactory for the catalog
crf)

Constructor

Method Summary

Modifier and TypeMethod and Description
pack-priv int

Returns:

int The base column position for the column.
getBaseColumnPosition(int
The column number within the index
colNumber)

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

pack-priv int

Returns:

int The column count for the index.
getColumnCount()

Get the column count for the index.

pack-priv long

Returns:

long The conglomerate number for the index.
getConglomerateNumber()

Get the conglomerate number for the index.

pack-priv String

Returns:

String The index name for the index.
getIndexName()

Get the index name for the index.

pack-priv IndexRowGenerator

Returns:

IndexRowGenerator The IRG for this index.
getIndexRowGenerator()

Get the IndexRowGenerator for this index.

pack-priv boolean

Returns:

boolean Whether or not this index is declared unique
isIndexUnique()

Return whether or not this index is declared unique

pack-priv void
setConglomerateNumber(long
The conglomerateNumber for the index.
conglomerateNumber)

Set the conglomerate number for the index.

pack-priv void
setIndexRowGenerator(IndexRowGenerator
The IndexRowGenerator for this index.
irg)

Set the IndexRowGenerator for this index.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

conglomerateNumberback to summary
private long conglomerateNumber
crfback to summary
private final CatalogRowFactory crf
indexNumberback to summary
private final int indexNumber
irgback to summary
private IndexRowGenerator irg

Constructor Detail

IndexInfoImplback to summary
pack-priv IndexInfoImpl(int indexNumber, CatalogRowFactory crf)

Constructor

Parameters
indexNumber:int

(0-based) number of index within catalog's indexes

crf:CatalogRowFactory

CatalogRowFactory for the catalog

Method Detail

getBaseColumnPositionback to summary
pack-priv 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:int

The column number within the index

Returns:int

int The base column position for the column.

getColumnCountback to summary
pack-priv int getColumnCount()

Get the column count for the index.

Returns:int

int The column count for the index.

getConglomerateNumberback to summary
pack-priv long getConglomerateNumber()

Get the conglomerate number for the index.

Returns:long

long The conglomerate number for the index.

getIndexNameback to summary
pack-priv String getIndexName()

Get the index name for the index.

Returns:String

String The index name for the index.

getIndexRowGeneratorback to summary
pack-priv IndexRowGenerator getIndexRowGenerator()

Get the IndexRowGenerator for this index.

Returns:IndexRowGenerator

IndexRowGenerator The IRG for this index.

isIndexUniqueback to summary
pack-priv boolean isIndexUnique()

Return whether or not this index is declared unique

Returns:boolean

boolean Whether or not this index is declared unique

setConglomerateNumberback to summary
pack-priv void setConglomerateNumber(long conglomerateNumber)

Set the conglomerate number for the index.

Parameters
conglomerateNumber:long

The conglomerateNumber for the index.

setIndexRowGeneratorback to summary
pack-priv void setIndexRowGenerator(IndexRowGenerator irg)

Set the IndexRowGenerator for this index.

Parameters
irg:IndexRowGenerator

The IndexRowGenerator for this index.