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

Class CascadesRuleCall

java.lang.Object

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

All Implemented Interfaces:

PlannerRuleCall

@API(EXPERIMENTAL)
public class CascadesRuleCall
extends Object
implements PlannerRuleCall

A rule call implementation for the CascadesPlanner. This rule call implements the logic for handling new expressions as they are generated by a PlannerRule.onMatch(PlannerRuleCall) and passed to the rule call via the yield(ExpressionRef) method, which consists primarily of manipulating the implicit a memo data structure defined by GroupExpressionRefs and RelationalExpressions. An invoked rule can in turn call yield(com.apple.foundationdb.record.query.plan.temp.ExpressionRef<? extends com.apple.foundationdb.record.query.plan.temp.RelationalExpression>) or yieldPartialMatch(com.apple.foundationdb.record.query.plan.temp.AliasMap, com.apple.foundationdb.record.query.plan.temp.MatchCandidate, com.apple.foundationdb.record.query.plan.temp.RelationalExpression, com.apple.foundationdb.record.query.plan.temp.ExpressionRef<? extends com.apple.foundationdb.record.query.plan.temp.RelationalExpression>, com.apple.foundationdb.record.query.plan.temp.MatchInfo) to either declare a new resulting expression or to declare a new partial match between the current expression and some candidate expression.

Constructor Summary

Constructors

Constructor	Description
CascadesRuleCall(PlanContext context, PlannerRule<? extends Bindable> rule, GroupExpressionRef<RelationalExpression> root, Quantifiers.AliasResolver aliasResolver, PlannerBindings bindings)

Method Summary

Modifier and Type	Method	Description
Quantifiers.AliasResolver	getAliasResolver()	Returns the alias resolver that is currently in use and maintained by the planner.
PlannerBindings	getBindings()	Return the map of bindings that this rule's matcher expression produced, which includes (by contract) all of the bindings specified by the rule associated with this call.
PlanContext	getContext()	Get the planning context with metadata that might be relevant to the planner, such as the list of available indexes.
Collection<RelationalExpression>	getNewExpressions()
Set<PartialMatch>	getNewPartialMatches()
<U extends RelationalExpression> ExpressionRef<U>	ref(U expression)	Wrap the given planner expression in an implementation of ExpressionRef suitable for the planner associated with this rule.
void	run()
void	yield(ExpressionRef<? extends RelationalExpression> expression)	Notify the planner's data structures that the new expression contained in expression has been produced by the rule.
void	yieldPartialMatch(AliasMap boundAliasMap, MatchCandidate matchCandidate, RelationalExpression queryExpression, ExpressionRef<? extends RelationalExpression> candidateRef, MatchInfo matchInfo)	Notify the planner's data structures that a new partial match has been produced by the rule.

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.PlannerRuleCall

get

Constructor Detail

CascadesRuleCall

public CascadesRuleCall(@Nonnull
                        PlanContext context,
                        @Nonnull
                        PlannerRule<? extends Bindable> rule,
                        @Nonnull
                        GroupExpressionRef<RelationalExpression> root,
                        @Nonnull
                        Quantifiers.AliasResolver aliasResolver,
                        @Nonnull
                        PlannerBindings bindings)

Method Detail

run

public void run()

getAliasResolver

@Nonnull
public Quantifiers.AliasResolver getAliasResolver()

Description copied from interface: PlannerRuleCall

Returns the alias resolver that is currently in use and maintained by the planner.

Specified by:

getAliasResolver in interface PlannerRuleCall

Returns:

the alias resolver

getBindings

@Nonnull
public PlannerBindings getBindings()

Description copied from interface: PlannerRuleCall

Return the map of bindings that this rule's matcher expression produced, which includes (by contract) all of the bindings specified by the rule associated with this call. This method should be implemented by rule call implementations, but users of the rule should usually access these via PlannerRuleCall.get(ExpressionMatcher).

Specified by:

getBindings in interface PlannerRuleCall

Returns:

the map of bindings that the rule's matcher expression produced

getContext

@Nonnull
public PlanContext getContext()

Description copied from interface: PlannerRuleCall

Get the planning context with metadata that might be relevant to the planner, such as the list of available indexes.

Specified by:

getContext in interface PlannerRuleCall

Returns:

a PlanContext object with various metadata that could affect planning

yield

public void yield(@Nonnull
                  ExpressionRef<? extends RelationalExpression> expression)

Description copied from interface: PlannerRuleCall

Notify the planner's data structures that the new expression contained in expression has been produced by the rule. This method may be called zero or more times by the rule's onMatch() method.

Specified by:

yield in interface PlannerRuleCall

Parameters:

expression - the expression produced by the rule

yieldPartialMatch

public void yieldPartialMatch(@Nonnull
                              AliasMap boundAliasMap,
                              @Nonnull
                              MatchCandidate matchCandidate,
                              @Nonnull
                              RelationalExpression queryExpression,
                              @Nonnull
                              ExpressionRef<? extends RelationalExpression> candidateRef,
                              @Nonnull
                              MatchInfo matchInfo)

Description copied from interface: PlannerRuleCall

Notify the planner's data structures that a new partial match has been produced by the rule. This method may be called zero or more times by the rule's onMatch() method.

Specified by:

yieldPartialMatch in interface PlannerRuleCall

Parameters:

boundAliasMap - the alias map of bound correlated identifiers between query and candidate

matchCandidate - the match candidate

queryExpression - the query expression

candidateRef - the matching reference on the candidate side

matchInfo - an auxiliary structure to keep additional information about the match

ref

public <U extends RelationalExpression> ExpressionRef<U> ref(U expression)

Description copied from interface: PlannerRuleCall

Wrap the given planner expression in an implementation of ExpressionRef suitable for the planner associated with this rule. Different rule call implementations might use different reference types depending on the specifics of the associated planner.

Specified by:

ref in interface PlannerRuleCall

Type Parameters:

U - the type of the planner expression

Parameters:

expression - the planner expression to wrap in a reference type

Returns:

expression wrapped in a reference

getNewExpressions

@Nonnull
public Collection<RelationalExpression> getNewExpressions()

getNewPartialMatches

@Nonnull
public Set<PartialMatch> getNewPartialMatches()