QueryRecord.PartialResult.ExplainStep (Oracle® Coherence Java API Reference)

All Superinterfaces:

QueryRecord.PartialResult.RecordableStep, QueryRecord.PartialResult.Step

All Known Implementing Classes:

SimpleQueryRecord.PartialResult.ExplainStep

Enclosing interface:

QueryRecord.PartialResult
```
public static interface QueryRecord.PartialResult.ExplainStep
extends QueryRecord.PartialResult.RecordableStep
```
A QueryRecord.ExplainStep is a QueryRecord.PartialResult.RecordableStep that provides the ability to record the estimated cost of evaluating a filter as part of a query operation.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`QueryRecord.PartialResult.ExplainStep`	`ensureStep(Filter filter)`	Ensure an inner nested explain step for the given filter.
`void`	`recordEfficiency(int nCost)`	Record the calculated cost of applying the filter as defined by `calculateEffectiveness`

Methods inherited from interface com.tangosol.util.QueryRecord.PartialResult.RecordableStep
recordExtractor, recordPreFilterKeys

Methods inherited from interface com.tangosol.util.QueryRecord.PartialResult.Step
getDuration, getEfficiency, getFilterDescription, getIndexLookupRecords, getPostFilterKeySetSize, getPreFilterKeySetSize, getSteps

- Method Detail
  - recordEfficiency
```
void recordEfficiency(int nCost)
```
    Record the calculated cost of applying the filter as defined by calculateEffectiveness
    
    Parameters:
    
    nCost - an effectiveness estimate of how well the associated filter can use any applicable index
  - ensureStep
```
QueryRecord.PartialResult.ExplainStep ensureStep(Filter filter)
```
    Ensure an inner nested explain step for the given filter. If there is no inner nested step associated with the given filter then a new step is created.
    
    Parameters:
    
    filter - the filter to associate the new step with
    
    Returns:
    
    the inner nested step associated with the given filter