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

Class RecordTypesProperty

java.lang.Object

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

All Implemented Interfaces:

PlannerProperty<Set<String>>

@API(value=EXPERIMENTAL)
public class RecordTypesProperty
extends Object
implements PlannerProperty<Set<String>>

A property visitor that determines the set of record type names (as Strings) that a RelationalPlannerExpression could produce. This property is used in determining whether type filters are necessary, among other things.

Method Summary

Modifier and Type	Method and Description
static Set<String>	evaluate(PlanContext context, ExpressionRef<? extends PlannerExpression> ref)
static Set<String>	evaluate(PlanContext context, PlannerExpression ref)
Set<String>	evaluateAtExpression(PlannerExpression expression, List<Set<String>> childResults) Evaluate the property at the given expression, using the results of evaluating the property at its children.
Set<String>	evaluateAtRef(ExpressionRef<? extends PlannerExpression> ref, List<Set<String>> memberResults) Evaluate the property at the given reference, using the results of evaluating the property at its members.
boolean	shouldVisit(ExpressionRef<? extends PlannerExpression> ref) Return whether the property should visit the subtree rooted at the given expression.
boolean	shouldVisit(PlannerExpression expression) Return whether the property should visit the subtree rooted at the given expression.

Methods inherited from class java.lang.Object

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

Method Detail

shouldVisit

public boolean shouldVisit(@Nonnull
                           PlannerExpression expression)

Description copied from interface: PlannerProperty

Return whether the property should visit the subtree rooted at the given expression. Called on nodes in the expression tree in visit pre-order of the depth-first traversal of the tree. That is, as each node is visited for the first time, shouldVisit() is called on that node. If shouldVisit() returns false, then PlannerProperty.evaluateAtExpression(PlannerExpression, List) will not be called on the given expression.

Specified by:

shouldVisit in interface PlannerProperty<Set<String>>

Parameters:

expression - the planner expression to visit

Returns:

true if the children of expression should be visited and false if they should not be visited

shouldVisit

public boolean shouldVisit(@Nonnull
                           ExpressionRef<? extends PlannerExpression> ref)

Description copied from interface: PlannerProperty

Return whether the property should visit the subtree rooted at the given expression. Called on nodes in the expression tree in visit pre-order of the depth-first traversal of the tree. That is, as each node is visited for the first time, shouldVisit() is called on that node. If shouldVisit() returns false, then PlannerProperty.evaluateAtRef(ExpressionRef, List) will not be called on the given expression.

Specified by:

shouldVisit in interface PlannerProperty<Set<String>>

Parameters:

ref - the expression reference to visit

Returns:

true if the members of ref should be visited and false if they should not be visited

evaluateAtExpression

@Nonnull
public Set<String> evaluateAtExpression(@Nonnull
                                                 PlannerExpression expression,
                                                 @Nonnull
                                                 List<Set<String>> 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 expression tree in visit post-order of the depth-first traversal of the tree. That is, as each node is visited for the last time (after all of its children have been visited, if applicable), evaluateAtExpression() is called on that node.

Specified by:

evaluateAtExpression in interface PlannerProperty<Set<String>>

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 Set<String> evaluateAtRef(@Nonnull
                                          ExpressionRef<? extends PlannerExpression> ref,
                                          @Nonnull
                                          List<Set<String>> 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 expression tree in visit post-order of the depth-first traversal of the tree. That is, as each node is visited for the last time (after all of its children have been visited, if applicable), evaluateAtRef() is called on that node.

Specified by:

evaluateAtRef in interface PlannerProperty<Set<String>>

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

@Nonnull
public static Set<String> evaluate(@Nonnull
                                            PlanContext context,
                                            ExpressionRef<? extends PlannerExpression> ref)

evaluate

@Nonnull
public static Set<String> evaluate(@Nonnull
                                            PlanContext context,
                                            @Nonnull
                                            PlannerExpression ref)