Top Description Fields Constructors Methods
org.apache.derby.impl.store.access.heap

pack-priv Class HeapScanInfo

extends Object
implements ScanInfo
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.store.access.ScanInfo
Imports
org.apache.derby.iapi.store.access.ScanInfo, org.apache.derby.shared.common.error.StandardException, org.apache.derby.shared.common.reference.SQLState, org.apache.derby.iapi.services.io.FormatableBitSet, org.apache.derby.shared.common.i18n.MessageService, java.util.Properties

This object provides performance information related to an open scan. The information is accumulated during operations on a ScanController() and then copied into this object and returned by a call to ScanController.getStatistic().
See Also
org.apache.derby.iapi.store.access.ScanController#getScanInfo()

Field Summary

Modifier and TypeField and Description
private int
private int
stat_numpages_visited

Performance counters ...

private int
private int
private FormatableBitSet

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public Properties
getAllScanInfo(Properties
Property list to fill in.
prop
)

Implements org.apache.derby.iapi.store.access.ScanInfo.getAllScanInfo.

Return all information gathered about the scan.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

stat_numColumnsFetchedback to summary
private int stat_numColumnsFetched
stat_numpages_visitedback to summary
private int stat_numpages_visited

Performance counters ...

stat_numrows_qualifiedback to summary
private int stat_numrows_qualified
stat_numrows_visitedback to summary
private int stat_numrows_visited
stat_validColumnsback to summary
private FormatableBitSet stat_validColumns

Constructor Detail

HeapScanInfoback to summary
pack-priv HeapScanInfo(HeapScan scan)

Method Detail

getAllScanInfoback to summary
public Properties getAllScanInfo(Properties prop) throws StandardException

Implements org.apache.derby.iapi.store.access.ScanInfo.getAllScanInfo.

Return all information gathered about the scan.

This routine returns a list of properties which contains all information gathered about the scan. If a Property is passed in, then that property list is appeneded to, otherwise a new property object is created and returned.

Not all scans may support all properties, if the property is not supported then it will not be returned. The following is a list of properties that may be returned: numPagesVisited - the number of pages visited during the scan. For btree scans this number only includes the leaf pages visited. numRowsVisited - the number of rows visited during the scan. This number includes all rows, including: those marked deleted, those that don't meet qualification, ... numRowsQualified - the number of undeleted rows, which met the qualification. treeHeight (btree's only) - for btree's the height of the tree. A tree with one page has a height of 1. Total number of pages visited in a btree scan is (treeHeight - 1 + numPagesVisited). NOTE - this list will be expanded as more information about the scan is gathered and returned.

Parameters
prop:Properties

Property list to fill in.

Exceptions
StandardException:
Standard exception policy.