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

java.lang.Object
  org.apache.derby.impl.sql.catalog.IndexScan

public class IndexScan

extends java.lang.Object

Convience class for scanning an index.

Field Summary

(package private) ExecRow	baseRow
private RowLocation	baseRowLocation
(package private) DataDictionary	dataDictionary
(package private) DataValueFactory	dvf
(package private) ExecutionFactory	ef
(package private) ConglomerateController	heapCC
(package private) int	indexId
(package private) ExecIndexRow	indexRow
(package private) ScanQualifier[][]	qualifiers
(package private) CatalogRowFactory	rf
(package private) ScanController	sc
(package private) TransactionController	tc
(package private) TabInfo	ti

Constructor Summary

IndexScan(DataDictionary dataDictionary, TabInfo ti, int indexId, DataValueDescriptor[] keyCols, ScanQualifier[][] qualifiers)
Create a scan on an index.

Method Summary

void	close() Close the scan.
ExecIndexRow	fetch() Fetch a row from the index scan.
ExecRow	fetchBaseRow() Fetch the base row corresponding to the current index row

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ti

TabInfo ti

indexId

int indexId

qualifiers

ScanQualifier[][] qualifiers

ef

ExecutionFactory ef

tc

TransactionController tc

dataDictionary

DataDictionary dataDictionary

heapCC

ConglomerateController heapCC

dvf

DataValueFactory dvf

baseRowLocation

private RowLocation baseRowLocation

baseRow

ExecRow baseRow

rf

CatalogRowFactory rf

indexRow

ExecIndexRow indexRow

sc

ScanController sc

Constructor Detail

IndexScan

public IndexScan(DataDictionary dataDictionary,
                 TabInfo ti,
                 int indexId,
                 DataValueDescriptor[] keyCols,
                 ScanQualifier[][] qualifiers)
          throws StandardException

Create a scan on an index.

Parameters:

dataDictionary - the namespace

ti - TabInfo for the system table associated with the index.

indexId - the id for the index (From the CatalogRowFactory).

keyCols - the key columns for the scan.

qualifiers - qualifiers

Throws:

StandardException - Ooops

Method Detail

fetch

public ExecIndexRow fetch()
                   throws StandardException

Fetch a row from the index scan.

Returns:

The row or null. Note that the next call to fetch will replace the columns in the returned row.

Throws:

StandardException - Ooops

fetchBaseRow

public ExecRow fetchBaseRow()
                     throws StandardException

Fetch the base row corresponding to the current index row

Returns:

The base row row or null.

Throws:

StandardException - Ooops

close

public void close()
           throws StandardException

Close the scan.

Throws:

StandardException