Package com.apple.foundationdb.record.query.plan.temp.properties

Class UnmatchedFieldsProperty

java.lang.Object

com.apple.foundationdb.record.query.plan.temp.properties.UnmatchedFieldsProperty

All Implemented Interfaces:

PlannerProperty<Integer>

@API(EXPERIMENTAL)
public class UnmatchedFieldsProperty
extends Object
implements PlannerProperty<Integer>

A property for counting the total number of KeyExpression columns (i.e., field-like KeyExpressions such as FieldKeyExpression and RecordTypeKeyExpression) that are not matched with at least one Comparisons.Comparison in a planner expression tree. This is computed over all KeyExpressions in various scan expressions over indexes (e.g. IndexScanExpression, RecordQueryScanPlan), and also primary scans (e.g. RecordQueryScanPlan).

For example, suppose that a planner expression scans two indexes:

• concat(field1, field2), with a comparison field1 = 'foo'
• concat(field1, field3, field4), with a comparison field1 = 'foo', field3 < 5

The UnmatchedFieldsProperty on such a planner expression is 2.

Constructor Summary

Constructors

Constructor	Description
UnmatchedFieldsProperty(PlanContext context)

Method Summary

Modifier and Type	Method	Description
static int	evaluate(PlanContext context, RelationalExpression expression)
Integer	evaluateAtExpression(RelationalExpression expression, List<Integer> childResults)	Evaluate the property at the given expression, using the results of evaluating the property at its children.
Integer	evaluateAtRef(ExpressionRef<? extends RelationalExpression> ref, List<Integer> memberResults)	Evaluate the property at the given reference, using the results of evaluating the property at its members.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.apple.foundationdb.record.query.plan.temp.PlannerProperty

evaluateAtQuantifier, shouldVisit, shouldVisit, shouldVisit

Constructor Detail

UnmatchedFieldsProperty

public UnmatchedFieldsProperty(@Nonnull
                               PlanContext context)

Method Detail

evaluateAtExpression

@Nonnull
public Integer evaluateAtExpression(@Nonnull
                                    RelationalExpression expression,
                                    @Nonnull
                                    List<Integer> childResults)

Description copied from interface: PlannerProperty

Evaluate the property at the given expression, using the results of evaluating the property at its children. Called on nodes in the graph in visit post-order of the depth-first traversal of the graph. That is, as each expression is visited (after all of its children have been visited, if applicable), evaluateAtExpression() is called on that expression.

Specified by:

evaluateAtExpression in interface PlannerProperty<Integer>

Parameters:

expression - the cursor to visit

childResults - the results of the property evaluated at the children of expression

Returns:

the value of property at the given expression

evaluateAtRef

@Nonnull
public Integer evaluateAtRef(@Nonnull
                             ExpressionRef<? extends RelationalExpression> ref,
                             @Nonnull
                             List<Integer> memberResults)

Description copied from interface: PlannerProperty

Evaluate the property at the given reference, using the results of evaluating the property at its members. Called on nodes in the graph in visit post-order of the depth-first traversal of the graph. That is, as each reference is visited (after all of its members have been visited, if applicable), evaluateAtRef() is called on that reference.

Specified by:

evaluateAtRef in interface PlannerProperty<Integer>

Parameters:

ref - the expression reference to visit

memberResults - the results of the property evaluated at the members of ref

Returns:

the value of property at the given reference

evaluate

public static int evaluate(@Nonnull
                           PlanContext context,
                           @Nonnull
                           RelationalExpression expression)