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

Class ExpressionMatcher.DefaultMatcher<T extends Bindable>

java.lang.Object

com.apple.foundationdb.record.query.plan.temp.matchers.ExpressionMatcher.DefaultMatcher<T>

Type Parameters:

T - a sub class of Bindable

All Implemented Interfaces:

ExpressionMatcher<T>

Direct Known Subclasses:

ReferenceMatcher

Enclosing interface:

ExpressionMatcher<T extends Bindable>

public static class ExpressionMatcher.DefaultMatcher<T extends Bindable>
extends Object
implements ExpressionMatcher<T>

A default matcher. Matches nothing! This class is meant to serve as a super class for simple implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.query.plan.temp.matchers.ExpressionMatcher

ExpressionMatcher.DefaultMatcher<T extends Bindable>

Constructor Summary

Constructors

Constructor	Description
DefaultMatcher()

Method Summary

Modifier and Type	Method	Description
Class<? extends Bindable>	getRootClass()	Get a class or interface extending RelationalExpression that is a super class of every planner expression that this matcher can match.
Stream<PlannerBindings>	matchWith(PlannerBindings outerBindings, ExpressionRef<? extends RelationalExpression> ref, List<? extends Bindable> children)	Attempt to match this matcher against the given expression reference.
Stream<PlannerBindings>	matchWith(PlannerBindings outerBindings, MatchPartition matchPartition, List<? extends Bindable> children)	Attempt to match this matcher against the given MatchPartition.
Stream<PlannerBindings>	matchWith(PlannerBindings outerBindings, PartialMatch partialMatch, List<? extends Bindable> children)	Attempt to match this matcher against the given PartialMatch.
Stream<PlannerBindings>	matchWith(PlannerBindings outerBindings, Quantifier quantifier, List<? extends Bindable> children)	Attempt to match this matcher against the given Quantifier.
Stream<PlannerBindings>	matchWith(PlannerBindings outerBindings, RelationalExpression expression, List<? extends Bindable> children)	Attempt to match this matcher against the given ExpressionMatcher.
Stream<PlannerBindings>	matchWith(PlannerBindings outerBindings, QueryPredicate predicate, List<? extends Bindable> children)	Attempt to match this matcher against the given QueryPredicate.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMatcher

public DefaultMatcher()

Method Detail

getRootClass

@Nonnull
public Class<? extends Bindable> getRootClass()

Description copied from interface: ExpressionMatcher

Get a class or interface extending RelationalExpression that is a super class of every planner expression that this matcher can match. Ideally, it should be the lowest such class but it may not be. A planner will generally use this method to quickly determine a set of rules that could match an expression, without considering each rule and trying to apply it. A good implementation of this method helps the planner match rules efficiently.

Specified by:

getRootClass in interface ExpressionMatcher<T extends Bindable>

Returns:

a class object for a class that is a super class of every planner expression this matcher can match

matchWith

@Nonnull
public Stream<PlannerBindings> matchWith(@Nonnull
                                         PlannerBindings outerBindings,
                                         @Nonnull
                                         ExpressionRef<? extends RelationalExpression> ref,
                                         @Nonnull
                                         List<? extends Bindable> children)

Description copied from interface: ExpressionMatcher

Attempt to match this matcher against the given expression reference. Note that implementations of matchWith() should only attempt to match the given root with this planner expression or attempt to access the members of the given reference.

Specified by:

matchWith in interface ExpressionMatcher<T extends Bindable>

Parameters:

outerBindings - preexisting bindings to be used by the matcher

ref - a reference to match with

children - the conceptual children of ref, i.e. the memmbers of the group reference.

Returns:

a stream of PlannerBindings containing the matched bindings, or an empty stream is no match was found

matchWith

@Nonnull
public Stream<PlannerBindings> matchWith(@Nonnull
                                         PlannerBindings outerBindings,
                                         @Nonnull
                                         RelationalExpression expression,
                                         @Nonnull
                                         List<? extends Bindable> children)

Description copied from interface: ExpressionMatcher

Attempt to match this matcher against the given ExpressionMatcher. Note that implementations of matchWith() should only attempt to match the given root with this planner expression.

Specified by:

matchWith in interface ExpressionMatcher<T extends Bindable>

Parameters:

outerBindings - preexisting bindings to be used by the matcher

expression - a planner expression to match with

children - the conceptual children of expression

Returns:

a stream of PlannerBindings containing the matched bindings, or an empty stream is no match was found

matchWith

@Nonnull
public Stream<PlannerBindings> matchWith(@Nonnull
                                         PlannerBindings outerBindings,
                                         @Nonnull
                                         QueryPredicate predicate,
                                         @Nonnull
                                         List<? extends Bindable> children)

Description copied from interface: ExpressionMatcher

Attempt to match this matcher against the given QueryPredicate. Note that implementations of matchWith() should only attempt to match the given root with this planner expression.

Specified by:

matchWith in interface ExpressionMatcher<T extends Bindable>

Parameters:

outerBindings - preexisting bindings to be used by the matcher

predicate - a predicate to match with

children - the conceptual children of predicate

Returns:

a stream of PlannerBindings containing the matched bindings, or an empty stream is no match was found

matchWith

@Nonnull
public Stream<PlannerBindings> matchWith(@Nonnull
                                         PlannerBindings outerBindings,
                                         @Nonnull
                                         Quantifier quantifier,
                                         @Nonnull
                                         List<? extends Bindable> children)

Description copied from interface: ExpressionMatcher

Attempt to match this matcher against the given Quantifier. Note that implementations of matchWith() should only attempt to match the given root with this planner expression.

Specified by:

matchWith in interface ExpressionMatcher<T extends Bindable>

Parameters:

outerBindings - preexisting bindings to be used by the matcher

quantifier - a quantifier to match with

children - the conceptual children of quantifier

Returns:

a stream of PlannerBindings containing the matched bindings, or an empty stream is no match was found

matchWith

@Nonnull
public Stream<PlannerBindings> matchWith(@Nonnull
                                         PlannerBindings outerBindings,
                                         @Nonnull
                                         PartialMatch partialMatch,
                                         @Nonnull
                                         List<? extends Bindable> children)

Description copied from interface: ExpressionMatcher

Attempt to match this matcher against the given PartialMatch. Note that implementations of matchWith() should only attempt to match the given root with this planner expression.

Specified by:

matchWith in interface ExpressionMatcher<T extends Bindable>

Parameters:

outerBindings - preexisting bindings to be used by the matcher

partialMatch - a partial match to match with

children - the conceptual children of predicate

Returns:

a stream of PlannerBindings containing the matched bindings, or an empty stream is no match was found

matchWith

@Nonnull
public Stream<PlannerBindings> matchWith(@Nonnull
                                         PlannerBindings outerBindings,
                                         @Nonnull
                                         MatchPartition matchPartition,
                                         @Nonnull
                                         List<? extends Bindable> children)

Description copied from interface: ExpressionMatcher

Attempt to match this matcher against the given MatchPartition. Note that implementations of matchWith() should only attempt to match the given root with this planner expression.

Specified by:

matchWith in interface ExpressionMatcher<T extends Bindable>

Parameters:

outerBindings - preexisting bindings to be used by the matcher

matchPartition - to match with

children - the conceptual children of predicate

Returns:

a stream of PlannerBindings containing the matched bindings, or an empty stream is no match was found