Package org.apache.calcite.rel.rules

Class FilterProjectTransposeRule

java.lang.Object

org.apache.calcite.plan.RelOptRule

org.apache.calcite.rel.rules.FilterProjectTransposeRule

Direct Known Subclasses:

DruidRules.DruidFilterProjectTransposeRule

public class FilterProjectTransposeRule
extends RelOptRule

Planner rule that pushes a Filter past a Project.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	copyFilter
private boolean	copyProject
static FilterProjectTransposeRule	INSTANCE	The default instance of FilterProjectTransposeRule.

Fields inherited from class org.apache.calcite.plan.RelOptRule

description, operands, relBuilderFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
	FilterProjectTransposeRule(java.lang.Class<? extends Filter> filterClass, java.lang.Class<? extends Project> projectClass, boolean copyFilter, boolean copyProject, RelBuilderFactory relBuilderFactory)	Creates a FilterProjectTransposeRule.
	FilterProjectTransposeRule(java.lang.Class<? extends Filter> filterClass, RelFactories.FilterFactory filterFactory, java.lang.Class<? extends Project> projectClass, RelFactories.ProjectFactory projectFactory)	Deprecated.
	FilterProjectTransposeRule(java.lang.Class<F> filterClass, java.util.function.Predicate<? super F> filterPredicate, java.lang.Class<P> projectClass, java.util.function.Predicate<? super P> projectPredicate, boolean copyFilter, boolean copyProject, RelBuilderFactory relBuilderFactory)	Creates a FilterProjectTransposeRule.
protected	FilterProjectTransposeRule(RelOptRuleOperand operand, boolean copyFilter, boolean copyProject, RelBuilderFactory relBuilderFactory)

Method Summary

Modifier and Type	Method	Description
void	onMatch(RelOptRuleCall call)	Receives notification about a rule match.

Methods inherited from class org.apache.calcite.plan.RelOptRule

any, convert, convert, convertList, convertOperand, convertOperand, equals, equals, getOperand, getOperands, getOutConvention, getOutTrait, hashCode, matches, none, operand, operand, operand, operand, operand, operandJ, operandJ, some, toString, unordered

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INSTANCE

public static final FilterProjectTransposeRule INSTANCE

The default instance of FilterProjectTransposeRule.

It matches any kind of Join or Filter, and generates the same kind of Join and Filter.

It does not allow a Filter to be pushed past the Project if there is a correlation condition) anywhere in the Filter, since in some cases it can prevent a Correlate from being de-correlated.

copyFilter

private final boolean copyFilter

copyProject

private final boolean copyProject

Constructor Detail

FilterProjectTransposeRule

public FilterProjectTransposeRule(java.lang.Class<? extends Filter> filterClass,
                                  java.lang.Class<? extends Project> projectClass,
                                  boolean copyFilter,
                                  boolean copyProject,
                                  RelBuilderFactory relBuilderFactory)

Creates a FilterProjectTransposeRule.

Equivalent to the rule created by FilterProjectTransposeRule(Class, Predicate, Class, Predicate, boolean, boolean, RelBuilderFactory) with some default predicates that do not allow a filter to be pushed past the project if there is a correlation condition anywhere in the filter (since in some cases it can prevent a Correlate from being de-correlated).

FilterProjectTransposeRule

public FilterProjectTransposeRule(java.lang.Class<F> filterClass,
                                  java.util.function.Predicate<? super F> filterPredicate,
                                  java.lang.Class<P> projectClass,
                                  java.util.function.Predicate<? super P> projectPredicate,
                                  boolean copyFilter,
                                  boolean copyProject,
                                  RelBuilderFactory relBuilderFactory)

Creates a FilterProjectTransposeRule.

If copyFilter is true, creates the same kind of Filter as matched in the rule, otherwise it creates a Filter using the RelBuilder obtained by the relBuilderFactory. Similarly for copyProject.

Defining predicates for the Filter (using filterPredicate) and/or the Project (using projectPredicate allows making the rule more restrictive.

FilterProjectTransposeRule

@Deprecated
public FilterProjectTransposeRule(java.lang.Class<? extends Filter> filterClass,
                                  RelFactories.FilterFactory filterFactory,
                                  java.lang.Class<? extends Project> projectClass,
                                  RelFactories.ProjectFactory projectFactory)

Deprecated.

FilterProjectTransposeRule

protected FilterProjectTransposeRule(RelOptRuleOperand operand,
                                     boolean copyFilter,
                                     boolean copyProject,
                                     RelBuilderFactory relBuilderFactory)

Method Detail

onMatch

public void onMatch(RelOptRuleCall call)

Description copied from class: RelOptRule

Receives notification about a rule match. At the time that this method is called, call.rels holds the set of relational expressions which match the operands to the rule; call.rels[0] is the root expression.

Typically a rule would check that the nodes are valid matches, creates a new expression, then calls back RelOptRuleCall.transformTo(org.apache.calcite.rel.RelNode, java.util.Map<org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode>) to register the expression.

Specified by:

onMatch in class RelOptRule

Parameters:

call - Rule call

See Also:

RelOptRule.matches(RelOptRuleCall)