org.apache.calcite.plan

Interface RelRule.Config

All Known Subinterfaces:

AbstractConverter.ExpandConversionRule.Config, AbstractJoinExtractFilterRule.Config, AggregateCaseToFilterRule.Config, AggregateExpandDistinctAggregatesRule.Config, AggregateExtractProjectRule.Config, AggregateFilterTransposeRule.Config, AggregateJoinJoinRemoveRule.Config, AggregateJoinRemoveRule.Config, AggregateJoinTransposeRule.Config, AggregateMergeRule.Config, AggregateProjectMergeRule.Config, AggregateProjectPullUpConstantsRule.Config, AggregateProjectStarTableRule.Config, AggregateReduceFunctionsRule.Config, AggregateRemoveRule.Config, AggregateStarTableRule.Config, AggregateUnionAggregateRule.Config, AggregateUnionTransposeRule.Config, AggregateValuesRule.Config, Bindables.BindableTableScanRule.Config, CalcMergeRule.Config, CalcRemoveRule.Config, CalcSplitRule.Config, CoerceInputsRule.Config, CommonRelSubExprRule.Config, ConverterRule.Config, DateRangeRules.FilterDateRangeRule.Config, EnumerableBatchNestedLoopJoinRule.Config, EnumerableFilterToCalcRule.Config, EnumerableLimitRule.Config, EnumerableLimitSortRule.Config, EnumerableProjectToCalcRule.Config, ExchangeRemoveConstantKeysRule.Config, FilterAggregateTransposeRule.Config, FilterCalcMergeRule.Config, FilterCorrelateRule.Config, FilterJoinRule.Config, FilterJoinRule.FilterIntoJoinRule.Config, FilterJoinRule.JoinConditionPushRule.Config, FilterMergeRule.Config, FilterMultiJoinMergeRule.Config, FilterProjectTransposeRule.Config, FilterRemoveIsNotDistinctFromRule.Config, FilterSetOpTransposeRule.Config, FilterTableFunctionTransposeRule.Config, FilterTableScanRule.Config, FilterToCalcRule.Config, IntersectToDistinctRule.Config, JoinAddRedundantSemiJoinRule.Config, JoinAssociateRule.Config, JoinCommuteRule.Config, JoinExtractFilterRule.Config, JoinProjectTransposeRule.Config, JoinPushExpressionsRule.Config, JoinPushThroughJoinRule.Config, JoinPushTransitivePredicatesRule.Config, JoinToCorrelateRule.Config, JoinToMultiJoinRule.Config, JoinUnionTransposeRule.Config, LoptOptimizeJoinRule.Config, MatchRule.Config, MaterializedViewAggregateRule.Config, MaterializedViewFilterScanRule.Config, MaterializedViewOnlyAggregateRule.Config, MaterializedViewOnlyFilterRule.Config, MaterializedViewOnlyJoinRule.Config, MaterializedViewProjectAggregateRule.Config, MaterializedViewProjectFilterRule.Config, MaterializedViewProjectJoinRule.Config, MaterializedViewRule.Config, MultiJoinOptimizeBushyRule.Config, MultiJoinProjectTransposeRule.Config, ProjectAggregateMergeRule.Config, ProjectCalcMergeRule.Config, ProjectCorrelateTransposeRule.Config, ProjectFilterTransposeRule.Config, ProjectJoinJoinRemoveRule.Config, ProjectJoinRemoveRule.Config, ProjectJoinTransposeRule.Config, ProjectMergeRule.Config, ProjectMultiJoinMergeRule.Config, ProjectRemoveRule.Config, ProjectSetOpTransposeRule.Config, ProjectTableScanRule.Config, ProjectToCalcRule.Config, ProjectToWindowRule.CalcToWindowRule.Config, ProjectToWindowRule.Config, ProjectToWindowRule.ProjectToLogicalProjectAndWindowRule.Config, ProjectWindowTransposeRule.Config, PruneEmptyRules.IntersectEmptyPruneRuleConfig, PruneEmptyRules.JoinLeftEmptyRuleConfig, PruneEmptyRules.JoinRightEmptyRuleConfig, PruneEmptyRules.MinusEmptyPruneRuleConfig, PruneEmptyRules.PruneEmptyRule.Config, PruneEmptyRules.RemoveEmptySingleRule.Config, PruneEmptyRules.SortFetchZeroRuleConfig, PruneEmptyRules.UnionEmptyPruneRuleConfig, ReduceDecimalsRule.Config, ReduceExpressionsRule.CalcReduceExpressionsRule.Config, ReduceExpressionsRule.Config, ReduceExpressionsRule.FilterReduceExpressionsRule.Config, ReduceExpressionsRule.JoinReduceExpressionsRule.Config, ReduceExpressionsRule.ProjectReduceExpressionsRule.Config, ReduceExpressionsRule.WindowReduceExpressionsRule.Config, RelDecorrelator.AdjustProjectForCountAggregateRule.Config, RelDecorrelator.Config, RelDecorrelator.RemoveCorrelationForScalarAggregateRule.Config, RelDecorrelator.RemoveCorrelationForScalarProjectRule.Config, RelDecorrelator.RemoveSingleAggregateRule.Config, SemiJoinFilterTransposeRule.Config, SemiJoinJoinTransposeRule.Config, SemiJoinProjectTransposeRule.Config, SemiJoinRemoveRule.Config, SemiJoinRule.Config, SemiJoinRule.JoinToSemiJoinRule.Config, SemiJoinRule.ProjectToSemiJoinRule.Config, SortJoinCopyRule.Config, SortJoinTransposeRule.Config, SortProjectTransposeRule.Config, SortRemoveConstantKeysRule.Config, SortRemoveRule.Config, SortUnionTransposeRule.Config, SpatialRules.FilterHilbertRule.Config, StreamRules.DeltaAggregateTransposeRule.Config, StreamRules.DeltaFilterTransposeRule.Config, StreamRules.DeltaJoinTransposeRule.Config, StreamRules.DeltaProjectTransposeRule.Config, StreamRules.DeltaSortTransposeRule.Config, StreamRules.DeltaTableScanRule.Config, StreamRules.DeltaTableScanToEmptyRule.Config, StreamRules.DeltaUnionTransposeRule.Config, SubQueryRemoveRule.Config, TableScanRule.Config, TraitMatchingRule.Config, UnionEliminatorRule.Config, UnionMergeRule.Config, UnionPullUpConstantsRule.Config, UnionToDistinctRule.Config, ValuesReduceRule.Config

Enclosing class:

RelRule<C extends RelRule.Config>

public static interface RelRule.Config

Rule configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static RelRule.Config	EMPTY Empty configuration.

Method Summary

Modifier and Type	Method and Description
default <T> T	as(Class<T> class_) Casts this configuration to another type, usually a sub-class.
String	description() Description of the rule instance.
RelRule.OperandTransform	operandSupplier() Creates the operands for the rule instance.
RelBuilderFactory	relBuilderFactory() The factory that is used to create a RelBuilder during rule invocations.
RelOptRule	toRule() Creates a rule that uses this configuration.
RelRule.Config	withDescription(String description) Sets description().
RelRule.Config	withOperandSupplier(RelRule.OperandTransform transform) Sets operandSupplier().
RelRule.Config	withRelBuilderFactory(RelBuilderFactory factory) Sets relBuilderFactory().

Field Detail

EMPTY

static final RelRule.Config EMPTY

Empty configuration.

Method Detail

toRule

RelOptRule toRule()

Creates a rule that uses this configuration. Sub-class must override.

as

default <T> T as(Class<T> class_)

Casts this configuration to another type, usually a sub-class.

relBuilderFactory

RelBuilderFactory relBuilderFactory()

The factory that is used to create a RelBuilder during rule invocations.

withRelBuilderFactory

RelRule.Config withRelBuilderFactory(RelBuilderFactory factory)

Sets relBuilderFactory().

description

String description()

Description of the rule instance.

withDescription

RelRule.Config withDescription(String description)

Sets description().

operandSupplier

RelRule.OperandTransform operandSupplier()

Creates the operands for the rule instance.

withOperandSupplier

RelRule.Config withOperandSupplier(RelRule.OperandTransform transform)

Sets operandSupplier().