QueryRecord::PartialResult::IndexLookupRecord Class Reference

Inherits Object.

Detailed Description

An IndexLookupRecord holds the recorded information about an index lookup performed during filter evaluation as part of a query record.

An IndexLookupRecord is created each time that RecordableStep#recordExtractor(ValueExtractor) is called on a query record step.


Public Types
typedef spec::Handle	Handle
	IndexLookupRecord Handle definition.
typedef spec::View	View
	IndexLookupRecord View definition.
typedef spec::Holder	Holder
	IndexLookupRecord Holder definition.
Public Member Functions
virtual String::View	getExtractorDescription () const =0
	Get a description of the extractor that was used for the index lookup.
virtual String::View	getIndexDescription () const =0
	Get a description of the associated index.
virtual bool	isOrdered () const =0
	Indicates whether or not the associated index is ordered.

virtual String::View getExtractorDescription ( ) const [pure virtual]

Get a description of the extractor that was used for the index lookup.

virtual String::View getIndexDescription ( ) const [pure virtual]

Get a description of the associated index.

Returns:: the index description; null if no index was found for the associated extractor

virtual bool isOrdered ( ) const [pure virtual]

Indicates whether or not the associated index is ordered.

Returns:: true if the associated index is ordered; false if the index is not ordered or if no index was found for the associated extractor

The documentation for this class was generated from the following file: