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

Class OrderingProperty

java.lang.Object

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

All Implemented Interfaces:

PlannerProperty<Optional<OrderingProperty.OrderingInfo>>

@API(EXPERIMENTAL)
public class OrderingProperty
extends Object
implements PlannerProperty<Optional<OrderingProperty.OrderingInfo>>

A property that determines whether the expression may produce duplicate entries. If the given expression is a RelationalExpression, this will return whether the expression might produce multiple instances of the same record. If the given expression is a KeyExpression, then this will return whether the expression might return multiple results for the same record.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OrderingProperty.OrderingInfo	Class to hold the info returned by this property.

Method Summary

Modifier and Type	Method	Description
static Optional<OrderingProperty.OrderingInfo>	evaluate(ExpressionRef<? extends RelationalExpression> ref, PlanContext context)
static Optional<OrderingProperty.OrderingInfo>	evaluate(RelationalExpression expression, PlanContext context)
Optional<OrderingProperty.OrderingInfo>	evaluateAtExpression(RelationalExpression expression, List<Optional<OrderingProperty.OrderingInfo>> childResults)	Evaluate the property at the given expression, using the results of evaluating the property at its children.
Optional<OrderingProperty.OrderingInfo>	evaluateAtRef(ExpressionRef<? extends RelationalExpression> ref, List<Optional<OrderingProperty.OrderingInfo>> 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

Method Detail

evaluateAtExpression

@Nonnull
public Optional<OrderingProperty.OrderingInfo> evaluateAtExpression(@Nonnull
                                                                    RelationalExpression expression,
                                                                    @Nonnull
                                                                    List<Optional<OrderingProperty.OrderingInfo>> 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<Optional<OrderingProperty.OrderingInfo>>

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 Optional<OrderingProperty.OrderingInfo> evaluateAtRef(@Nonnull
                                                             ExpressionRef<? extends RelationalExpression> ref,
                                                             @Nonnull
                                                             List<Optional<OrderingProperty.OrderingInfo>> 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<Optional<OrderingProperty.OrderingInfo>>

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 Optional<OrderingProperty.OrderingInfo> evaluate(@Nonnull
                                                               ExpressionRef<? extends RelationalExpression> ref,
                                                               @Nonnull
                                                               PlanContext context)

evaluate

public static Optional<OrderingProperty.OrderingInfo> evaluate(@Nonnull
                                                               RelationalExpression expression,
                                                               @Nonnull
                                                               PlanContext context)