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

Classes related to the Cascades matcher system and its implementation.

The Cascades planner is based on a system of rules, each of which is defined by a matcher expression and a method that is applied when an expression matches a given matcher expression. A matcher is represented by an implementation of the ExpressionMatcher interface and is responsible for inspecting the structure of a planner expression, determining whether it matches an expression, and providing bindings to access particular substructures of the expression during the execution of the rule. These bindings are exposed by the PlannerBindings class.

Interface Summary

Interface	Description
ExpressionChildrenMatcher	An ExpressionChildrenMatcher describes how to match the children of a RelationalExpression (i.e., the references returned by the RelationalExpression.getQuantifiers() method).
ExpressionMatcher<T extends Bindable>	A ExpressionMatcher is an expression that can be matched against a RelationalExpression tree, while binding certain expressions/references in the tree to expression matcher objects.

Class Summary

Class	Description
AnyChildMatcher	An expression children matcher that tries to match any child to the given ExpressionMatcher, producing a stream of bindings that is the concatenation of the (possibly empty) streams of bindings from attempting to match each child to the given matcher.
AnyChildrenMatcher	A children matcher that matches any set of children.
AnyChildWithRestMatcher	An expression matcher that tries to match any child to the given ExpressionMatcher while providing a ReferenceMatcher binding to all other children.
ExpressionMatcher.DefaultMatcher<T extends Bindable>	A default matcher.
ListChildrenMatcher	A matcher for a children that tries to match each child to a specified matcher.
MatchPartitionMatcher<T extends MatchPartition>	Matches a subclass of MatchPartition and a given matcher against the children.
MultiChildrenMatcher	An expression children matcher that tries to match a multitude of children to a single ExpressionMatcher.
MultiChildrenMatcher.AllChildrenMatcher	An expression children matcher that tries to match all children to a single ExpressionMatcher.
MultiChildrenMatcher.SomeChildrenMatcher	An expression children matcher that tries to match some children to a single ExpressionMatcher.
PartialMatchMatcher<T extends PartialMatch>	Matches a subclass of PartialMatch and a given matcher against the children.
PlannerBindings	A map-like structure that supports a map from a binding to a collection of Bindables, such as RelationalExpressions and ExpressionRefs.
PlannerBindings.Builder	A mutable builder for a set of PlannerBindings which can be used to incrementally build up a set of bindings without repeatedly calling PlannerBindings.mergedWith(PlannerBindings), which is less efficient.
QuantifierMatcher<T extends Quantifier>	Matches a subclass of Quantifier and a given matcher against the children.
ReferenceMatcher<T extends RelationalExpression>	An expression matcher that matches against any reference at all.
TypeMatcher<T extends Bindable>	A matcher that is specified by the class of its expression: to match any of several types of expressions, they must all implement a common interface (which itself extends PlannerExpression).
TypeWithPredicateMatcher<T extends RelationalExpressionWithPredicate>	Matches a subclass of RelationalExpressionWithPredicate with a given predicate (as determined by RelationalExpressionWithPredicate.getPredicate() and a given matcher against the children.