Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

QueryRecord::PartialResult::Step Class Reference

#include <coherence/util/QueryRecord.hpp>

Inherits Object.

List of all members.


Detailed Description

A QueryPlan.Step carries the recorded cost of evaluating a filter as part of a query operation.

This cost may be the estimated or actual execution cost depending on the type of the recorder in use when the step was created.
 

Public Types

typedef spec::Handle Handle
 Step Handle definition.
typedef spec::View View
 Step View definition.
typedef spec::Holder Holder
 Step Holder definition.

Public Member Functions

virtual String::View getFilterDescription () const =0
 Get a description of the filter that was associated with this step during its creation.
virtual Set::View getIndexLookupRecords () const =0
 Get the recorded information about the index lookups performed during filter evaluation as part of a query record.
virtual size32_t getEfficiency () const =0
 Get the calculated cost of applying the filter as defined by calculateEffectiveness.
virtual size32_t getPreFilterKeySetSize () const =0
 Get the size of the key set prior to evaluating the filter or applying an index.
virtual size32_t getPostFilterKeySetSize () const =0
 Get the size of the key set remaining after evaluating the filter or applying an index.
virtual int64_t getDuration () const =0
 Get the amount of time (in ms) spent evaluating the filter or applying an index for this query plan step.
virtual List::View getSteps () const =0
 Return inner nested steps, may be null if not nested.


Member Function Documentation

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

Get a description of the filter that was associated with this step during its creation.

Returns:
the description of the filter

virtual Set::View getIndexLookupRecords (  )  const [pure virtual]

Get the recorded information about the index lookups performed during filter evaluation as part of a query record.

Returns:
a set of IndexLookupRecord

virtual size32_t getEfficiency (  )  const [pure virtual]

Get the calculated cost of applying the filter as defined by calculateEffectiveness.

Returns:
an effectiveness estimate of how well the associated filter can use any applicable index

virtual size32_t getPreFilterKeySetSize (  )  const [pure virtual]

Get the size of the key set prior to evaluating the filter or applying an index.

This value can be used together with getPostFilterKeySetSize() to calculate an actual effectiveness (reduction of the key set) for this filter step.

Returns:
the size of the key set prior to evaluating the filter or applying an index

virtual size32_t getPostFilterKeySetSize (  )  const [pure virtual]

Get the size of the key set remaining after evaluating the filter or applying an index.

This value can be used together with getPreFilterKeySetSize() to calculate an actual effectiveness (reduction of the key set) for this filter step.

Returns:
the size of the key set after evaluating the filter or applying an index

virtual int64_t getDuration (  )  const [pure virtual]

Get the amount of time (in ms) spent evaluating the filter or applying an index for this query plan step.

Returns:
the number of milliseconds spent evaluating the filter

virtual List::View getSteps (  )  const [pure virtual]

Return inner nested steps, may be null if not nested.

Returns:
the inner nested steps in the order they are applied


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.