In preparation for [CALCITE-3923] and [CALCITE-4079], deprecate field…

…s and methods that will be removed between 1.24 and 1.25

Also, in RelNode, change some methods from 'to removed before 2.0'
to 'to be removed before 1.25'. The methods are sDistinct(),
isKey(ImmutableBitSet), getQuery(), getRows(), getVariablesStopped(),
computeSelfCost(), isValid(boolean), getCollationList(), getChildExps().

cassandra/src/main/java/org/apache/calcite/adapter/cassandra/CassandraRules.java

@@ -16,6 +16,7 @@
  */
 package org.apache.calcite.adapter.cassandra;
 
+import org.apache.calcite.adapter.enumerable.EnumerableConvention;
 import org.apache.calcite.adapter.enumerable.EnumerableLimit;
 import org.apache.calcite.adapter.java.JavaTypeFactory;
 import org.apache.calcite.plan.Convention;
@@ -55,6 +56,11 @@
 public class CassandraRules {
   private CassandraRules() {}
 
+  /** Rule to convert a relational expression from
+   * {@link CassandraRel#CONVENTION} to {@link EnumerableConvention}. */
+  public static final ConverterRule TO_ENUMERABLE =
+      new CassandraToEnumerableConverterRule(RelFactories.LOGICAL_BUILDER);
+
   public static final RelOptRule[] RULES = {
       CassandraFilterRule.INSTANCE,
       CassandraProjectRule.INSTANCE,

cassandra/src/main/java/org/apache/calcite/adapter/cassandra/CassandraTableScan.java

@@ -65,7 +65,7 @@ protected CassandraTableScan(RelOptCluster cluster, RelTraitSet traitSet,
   }
 
   @Override public void register(RelOptPlanner planner) {
-    planner.addRule(CassandraToEnumerableConverterRule.INSTANCE);
+    planner.addRule(CassandraRules.TO_ENUMERABLE);
     for (RelOptRule rule : CassandraRules.RULES) {
       planner.addRule(rule);
     }

cassandra/src/main/java/org/apache/calcite/adapter/cassandra/CassandraToEnumerableConverterRule.java

@@ -20,7 +20,6 @@
 import org.apache.calcite.plan.RelTraitSet;
 import org.apache.calcite.rel.RelNode;
 import org.apache.calcite.rel.convert.ConverterRule;
-import org.apache.calcite.rel.core.RelFactories;
 import org.apache.calcite.tools.RelBuilderFactory;
 
 import java.util.function.Predicate;
@@ -30,8 +29,10 @@
  * {@link CassandraRel#CONVENTION} to {@link EnumerableConvention}.
  */
 public class CassandraToEnumerableConverterRule extends ConverterRule {
+  /** @deprecated Use {@link CassandraRules#TO_ENUMERABLE}. */
+  @Deprecated // to be removed before 1.25
   public static final ConverterRule INSTANCE =
-      new CassandraToEnumerableConverterRule(RelFactories.LOGICAL_BUILDER);
+      CassandraRules.TO_ENUMERABLE;
 
   /**
    * Creates a CassandraToEnumerableConverterRule.

core/src/main/java/org/apache/calcite/adapter/enumerable/EnumerableBindable.java

@@ -30,7 +30,6 @@
 import org.apache.calcite.rel.RelNode;
 import org.apache.calcite.rel.convert.ConverterImpl;
 import org.apache.calcite.rel.convert.ConverterRule;
-import org.apache.calcite.rel.core.RelFactories;
 import org.apache.calcite.runtime.ArrayBindable;
 import org.apache.calcite.runtime.Bindable;
 import org.apache.calcite.tools.RelBuilderFactory;
@@ -86,8 +85,10 @@ public Node implement(final InterpreterImplementor implementor) {
    * Rule that converts any enumerable relational expression to bindable.
    */
   public static class EnumerableToBindableConverterRule extends ConverterRule {
+    /** @deprecated Use {@link EnumerableRules#TO_BINDABLE}. */
+    @Deprecated // to be removed before 1.25
     public static final EnumerableToBindableConverterRule INSTANCE =
-        new EnumerableToBindableConverterRule(RelFactories.LOGICAL_BUILDER);
+        EnumerableRules.TO_BINDABLE;
 
     /**
      * Creates an EnumerableToBindableConverterRule.

core/src/main/java/org/apache/calcite/adapter/enumerable/EnumerableInterpreterRule.java

@@ -19,7 +19,6 @@
 import org.apache.calcite.interpreter.BindableConvention;
 import org.apache.calcite.rel.RelNode;
 import org.apache.calcite.rel.convert.ConverterRule;
-import org.apache.calcite.rel.core.RelFactories;
 import org.apache.calcite.tools.RelBuilderFactory;
 
 import java.util.function.Predicate;
@@ -30,8 +29,10 @@
  * an {@link org.apache.calcite.adapter.enumerable.EnumerableInterpreter}.
  */
 public class EnumerableInterpreterRule extends ConverterRule {
+  /** @deprecated Use {@link EnumerableRules#TO_INTERPRETER}. */
+  @Deprecated // to be removed before 1.25
   public static final EnumerableInterpreterRule INSTANCE =
-      new EnumerableInterpreterRule(RelFactories.LOGICAL_BUILDER);
+      EnumerableRules.TO_INTERPRETER;
 
   /**
    * Creates an EnumerableInterpreterRule.

core/src/main/java/org/apache/calcite/adapter/enumerable/EnumerableRules.java

@@ -116,6 +116,17 @@ private EnumerableRules() {
   public static final EnumerableSortedAggregateRule ENUMERABLE_SORTED_AGGREGATE_RULE =
       new EnumerableSortedAggregateRule();
 
+  /** Rule that converts any enumerable relational expression to bindable. */
+  public static final EnumerableBindable.EnumerableToBindableConverterRule TO_BINDABLE =
+      new EnumerableBindable.EnumerableToBindableConverterRule(RelFactories.LOGICAL_BUILDER);
+
+  /**
+   * Rule that converts {@link org.apache.calcite.interpreter.BindableRel}
+   * to {@link org.apache.calcite.adapter.enumerable.EnumerableRel} by creating
+   * an {@link org.apache.calcite.adapter.enumerable.EnumerableInterpreter}. */
+  public static final EnumerableInterpreterRule TO_INTERPRETER =
+      new EnumerableInterpreterRule(RelFactories.LOGICAL_BUILDER);
+
   public static final List<RelOptRule> ENUMERABLE_RULES = ImmutableList.of(
       EnumerableRules.ENUMERABLE_JOIN_RULE,
       EnumerableRules.ENUMERABLE_MERGE_JOIN_RULE,

core/src/main/java/org/apache/calcite/adapter/jdbc/JdbcConvention.java

@@ -20,8 +20,7 @@
 import org.apache.calcite.plan.Convention;
 import org.apache.calcite.plan.RelOptPlanner;
 import org.apache.calcite.plan.RelOptRule;
-import org.apache.calcite.rel.rules.FilterSetOpTransposeRule;
-import org.apache.calcite.rel.rules.ProjectRemoveRule;
+import org.apache.calcite.rel.rules.CoreRules;
 import org.apache.calcite.sql.SqlDialect;
 
 /**
@@ -66,7 +65,7 @@ public static JdbcConvention of(SqlDialect dialect, Expression expression,
     for (RelOptRule rule : JdbcRules.rules(this)) {
       planner.addRule(rule);
     }
-    planner.addRule(FilterSetOpTransposeRule.INSTANCE);
-    planner.addRule(ProjectRemoveRule.INSTANCE);
+    planner.addRule(CoreRules.FILTER_SET_OP_TRANSPOSE);
+    planner.addRule(CoreRules.PROJECT_REMOVE);
   }
 }

core/src/main/java/org/apache/calcite/interpreter/Bindables.java

@@ -123,10 +123,15 @@ private Bindables() {}
   public static final RelOptRule BINDABLE_MATCH_RULE =
       new BindableMatchRule(RelFactories.LOGICAL_BUILDER);
 
+  /** Rule that converts a relational expression from
+   * {@link org.apache.calcite.plan.Convention#NONE}
+   * to {@link org.apache.calcite.interpreter.BindableConvention}. */
+  public static final ConverterRule FROM_NONE_RULE =
+      new NoneToBindableConverterRule(RelFactories.LOGICAL_BUILDER);
+
   /** All rules that convert logical relational expression to bindable. */
   public static final ImmutableList<RelOptRule> RULES =
-      ImmutableList.of(
-          NoneToBindableConverterRule.INSTANCE,
+      ImmutableList.of(FROM_NONE_RULE,
           BINDABLE_TABLE_SCAN_RULE,
           BINDABLE_FILTER_RULE,
           BINDABLE_PROJECT_RULE,

core/src/main/java/org/apache/calcite/interpreter/Interpreter.java

@@ -30,10 +30,7 @@
 import org.apache.calcite.plan.hep.HepProgramBuilder;
 import org.apache.calcite.rel.RelNode;
 import org.apache.calcite.rel.RelVisitor;
-import org.apache.calcite.rel.rules.AggregateReduceFunctionsRule;
-import org.apache.calcite.rel.rules.CalcSplitRule;
-import org.apache.calcite.rel.rules.FilterTableScanRule;
-import org.apache.calcite.rel.rules.ProjectTableScanRule;
+import org.apache.calcite.rel.rules.CoreRules;
 import org.apache.calcite.rel.type.RelDataType;
 import org.apache.calcite.rel.type.RelDataTypeFactory;
 import org.apache.calcite.rex.RexCall;
@@ -93,12 +90,12 @@ public Interpreter(DataContext dataContext, RelNode rootRel) {
 
   private RelNode optimize(RelNode rootRel) {
     final HepProgram hepProgram = new HepProgramBuilder()
-        .addRuleInstance(CalcSplitRule.INSTANCE)
-        .addRuleInstance(FilterTableScanRule.INSTANCE)
-        .addRuleInstance(FilterTableScanRule.INTERPRETER)
-        .addRuleInstance(ProjectTableScanRule.INSTANCE)
-        .addRuleInstance(ProjectTableScanRule.INTERPRETER)
-        .addRuleInstance(AggregateReduceFunctionsRule.INSTANCE)
+        .addRuleInstance(CoreRules.CALC_SPLIT)
+        .addRuleInstance(CoreRules.FILTER_SCAN)
+        .addRuleInstance(CoreRules.FILTER_INTERPRETER_SCAN)
+        .addRuleInstance(CoreRules.PROJECT_TABLE_SCAN)
+        .addRuleInstance(CoreRules.PROJECT_INTERPRETER_TABLE_SCAN)
+        .addRuleInstance(CoreRules.AGGREGATE_REDUCE_FUNCTIONS)
         .build();
     final HepPlanner planner = new HepPlanner(hepProgram);
     planner.setRoot(rootRel);

core/src/main/java/org/apache/calcite/interpreter/NoneToBindableConverterRule.java

@@ -20,7 +20,6 @@
 import org.apache.calcite.plan.RelTraitSet;
 import org.apache.calcite.rel.RelNode;
 import org.apache.calcite.rel.convert.ConverterRule;
-import org.apache.calcite.rel.core.RelFactories;
 import org.apache.calcite.tools.RelBuilderFactory;
 
 import java.util.function.Predicate;
@@ -31,8 +30,10 @@
  * to {@link org.apache.calcite.interpreter.BindableConvention}.
  */
 public class NoneToBindableConverterRule extends ConverterRule {
+  /** @deprecated Use {@link Bindables#FROM_NONE_RULE}. */
+  @Deprecated // to be removed before 1.25
   public static final ConverterRule INSTANCE =
-      new NoneToBindableConverterRule(RelFactories.LOGICAL_BUILDER);
+      Bindables.FROM_NONE_RULE;
 
   /**
    * Creates a NoneToBindableConverterRule.

core/src/main/java/org/apache/calcite/materialize/LatticeSuggester.java

@@ -31,7 +31,7 @@
 import org.apache.calcite.rel.core.SetOp;
 import org.apache.calcite.rel.core.Sort;
 import org.apache.calcite.rel.core.TableScan;
-import org.apache.calcite.rel.rules.FilterJoinRule;
+import org.apache.calcite.rel.rules.CoreRules;
 import org.apache.calcite.rel.type.RelDataTypeField;
 import org.apache.calcite.rex.RexInputRef;
 import org.apache.calcite.rex.RexNode;
@@ -77,8 +77,8 @@ public class LatticeSuggester {
 
   private static final HepProgram PROGRAM =
       new HepProgramBuilder()
-          .addRuleInstance(FilterJoinRule.FILTER_ON_JOIN)
-          .addRuleInstance(FilterJoinRule.JOIN)
+          .addRuleInstance(CoreRules.FILTER_INTO_JOIN)
+          .addRuleInstance(CoreRules.JOIN_CONDITION_PUSH)
           .build();
 
   /** Lattices, indexed by digest. Uses LinkedHashMap for determinacy. */

core/src/main/java/org/apache/calcite/plan/RelOptMaterialization.java

@@ -24,13 +24,7 @@
 import org.apache.calcite.rel.core.TableScan;
 import org.apache.calcite.rel.logical.LogicalJoin;
 import org.apache.calcite.rel.metadata.DefaultRelMetadataProvider;
-import org.apache.calcite.rel.rules.AggregateFilterTransposeRule;
-import org.apache.calcite.rel.rules.AggregateProjectMergeRule;
-import org.apache.calcite.rel.rules.FilterJoinRule;
-import org.apache.calcite.rel.rules.JoinProjectTransposeRule;
-import org.apache.calcite.rel.rules.ProjectFilterTransposeRule;
-import org.apache.calcite.rel.rules.ProjectMergeRule;
-import org.apache.calcite.rel.rules.ProjectRemoveRule;
+import org.apache.calcite.rel.rules.CoreRules;
 import org.apache.calcite.rex.RexNode;
 import org.apache.calcite.rex.RexUtil;
 import org.apache.calcite.schema.Table;
@@ -201,9 +195,9 @@ private void match(ProjectFilterTable left, ProjectFilterTable right,
       return null;
     }
     final Program program = Programs.hep(
-        ImmutableList.of(ProjectFilterTransposeRule.INSTANCE,
-            AggregateProjectMergeRule.INSTANCE,
-            AggregateFilterTransposeRule.INSTANCE),
+        ImmutableList.of(CoreRules.PROJECT_FILTER_TRANSPOSE,
+            CoreRules.AGGREGATE_PROJECT_MERGE,
+            CoreRules.AGGREGATE_FILTER_TRANSPOSE),
         false,
         DefaultRelMetadataProvider.INSTANCE);
     return program.run(null, rel2, null,
@@ -270,12 +264,11 @@ public RelOptTable getTable() {
    */
   public static RelNode toLeafJoinForm(RelNode rel) {
     final Program program = Programs.hep(
-        ImmutableList.of(
-            JoinProjectTransposeRule.RIGHT_PROJECT,
-            JoinProjectTransposeRule.LEFT_PROJECT,
-            FilterJoinRule.FilterIntoJoinRule.FILTER_ON_JOIN,
-            ProjectRemoveRule.INSTANCE,
-            ProjectMergeRule.INSTANCE),
+        ImmutableList.of(CoreRules.JOIN_PROJECT_RIGHT_TRANSPOSE,
+            CoreRules.JOIN_PROJECT_LEFT_TRANSPOSE,
+            CoreRules.FILTER_INTO_JOIN,
+            CoreRules.PROJECT_REMOVE,
+            CoreRules.PROJECT_MERGE),
         false,
         DefaultRelMetadataProvider.INSTANCE);
     if (CalciteSystemProperty.DEBUG.value()) {

core/src/main/java/org/apache/calcite/plan/RelOptMaterializations.java

@@ -22,19 +22,7 @@
 import org.apache.calcite.plan.hep.HepProgramBuilder;
 import org.apache.calcite.rel.RelNode;
 import org.apache.calcite.rel.core.RelFactories;
-import org.apache.calcite.rel.rules.CalcMergeRule;
-import org.apache.calcite.rel.rules.FilterAggregateTransposeRule;
-import org.apache.calcite.rel.rules.FilterCalcMergeRule;
-import org.apache.calcite.rel.rules.FilterJoinRule;
-import org.apache.calcite.rel.rules.FilterMergeRule;
-import org.apache.calcite.rel.rules.FilterProjectTransposeRule;
-import org.apache.calcite.rel.rules.FilterToCalcRule;
-import org.apache.calcite.rel.rules.ProjectCalcMergeRule;
-import org.apache.calcite.rel.rules.ProjectJoinTransposeRule;
-import org.apache.calcite.rel.rules.ProjectMergeRule;
-import org.apache.calcite.rel.rules.ProjectRemoveRule;
-import org.apache.calcite.rel.rules.ProjectSetOpTransposeRule;
-import org.apache.calcite.rel.rules.ProjectToCalcRule;
+import org.apache.calcite.rel.rules.CoreRules;
 import org.apache.calcite.sql2rel.RelFieldTrimmer;
 import org.apache.calcite.tools.RelBuilder;
 import org.apache.calcite.util.Pair;
@@ -200,20 +188,20 @@ private static List<RelNode> substitute(
     target = trimUnusedfields(target);
     HepProgram program =
         new HepProgramBuilder()
-            .addRuleInstance(FilterProjectTransposeRule.INSTANCE)
-            .addRuleInstance(FilterMergeRule.INSTANCE)
-            .addRuleInstance(FilterJoinRule.FILTER_ON_JOIN)
-            .addRuleInstance(FilterJoinRule.JOIN)
-            .addRuleInstance(FilterAggregateTransposeRule.INSTANCE)
-            .addRuleInstance(ProjectMergeRule.INSTANCE)
-            .addRuleInstance(ProjectRemoveRule.INSTANCE)
-            .addRuleInstance(ProjectJoinTransposeRule.INSTANCE)
-            .addRuleInstance(ProjectSetOpTransposeRule.INSTANCE)
-            .addRuleInstance(FilterToCalcRule.INSTANCE)
-            .addRuleInstance(ProjectToCalcRule.INSTANCE)
-            .addRuleInstance(FilterCalcMergeRule.INSTANCE)
-            .addRuleInstance(ProjectCalcMergeRule.INSTANCE)
-            .addRuleInstance(CalcMergeRule.INSTANCE)
+            .addRuleInstance(CoreRules.FILTER_PROJECT_TRANSPOSE)
+            .addRuleInstance(CoreRules.FILTER_MERGE)
+            .addRuleInstance(CoreRules.FILTER_INTO_JOIN)
+            .addRuleInstance(CoreRules.JOIN_CONDITION_PUSH)
+            .addRuleInstance(CoreRules.FILTER_AGGREGATE_TRANSPOSE)
+            .addRuleInstance(CoreRules.PROJECT_MERGE)
+            .addRuleInstance(CoreRules.PROJECT_REMOVE)
+            .addRuleInstance(CoreRules.PROJECT_JOIN_TRANSPOSE)
+            .addRuleInstance(CoreRules.PROJECT_SET_OP_TRANSPOSE)
+            .addRuleInstance(CoreRules.FILTER_TO_CALC)
+            .addRuleInstance(CoreRules.PROJECT_TO_CALC)
+            .addRuleInstance(CoreRules.FILTER_CALC_MERGE)
+            .addRuleInstance(CoreRules.PROJECT_CALC_MERGE)
+            .addRuleInstance(CoreRules.CALC_MERGE)
             .build();
 
     // We must use the same HEP planner for the two optimizations below.