Package com.tangosol.util

Interface QueryRecord.PartialResult.Step

All Known Subinterfaces:

QueryRecord.PartialResult.ExplainStep, QueryRecord.PartialResult.RecordableStep, QueryRecord.PartialResult.TraceStep

All Known Implementing Classes:

SimpleQueryRecord.PartialResult.AbstractRecordableStep, SimpleQueryRecord.PartialResult.ExplainStep, SimpleQueryRecord.PartialResult.Step, SimpleQueryRecord.PartialResult.TraceStep

Enclosing interface:

QueryRecord.PartialResult

public static interface QueryRecord.PartialResult.Step

A QueryRecord.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.

Method Summary

Modifier and Type	Method	Description
long	getDuration()	Get the amount of time (in ms) spent evaluating the filter or applying an index for this query plan step.
int	getEfficiency()	Get the calculated cost of applying the filter as defined by calculateEffectiveness
String	getFilterDescription()	Get a description of the filter that was associated with this step during its creation.
Set<? extends QueryRecord.PartialResult.IndexLookupRecord>	getIndexLookupRecords()	Get the recorded information about the index lookups performed during filter evaluation as part of a query record.
int	getPostFilterKeySetSize()	Get the size of the key set remaining after evaluating the filter or applying an index.
int	getPreFilterKeySetSize()	Get the size of the key set prior to evaluating the filter or applying an index.
List<? extends QueryRecord.PartialResult.Step>	getSteps()	Return inner nested steps, may be null if not nested.

Method Detail

getFilterDescription

String getFilterDescription()

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

Returns:

the description of the filter

getIndexLookupRecords

Set<? extends QueryRecord.PartialResult.IndexLookupRecord> getIndexLookupRecords()

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

Returns:

a set of QueryRecord.PartialResult.IndexLookupRecord

getEfficiency

int getEfficiency()

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

getPreFilterKeySetSize

int getPreFilterKeySetSize()

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

getPostFilterKeySetSize

int getPostFilterKeySetSize()

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

getDuration

long getDuration()

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

getSteps

List<? extends QueryRecord.PartialResult.Step> getSteps()

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

Returns:

the inner nested steps in the order they are applied