content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to you under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   *
   * http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.calcite.adapter.innodb;
  
  import org.apache.calcite.plan.RelOptCluster;
  import org.apache.calcite.plan.RelOptCost;
  import org.apache.calcite.plan.RelOptPlanner;
  import org.apache.calcite.plan.RelTraitSet;
  import org.apache.calcite.rel.RelCollation;
  import org.apache.calcite.rel.RelNode;
  import org.apache.calcite.rel.RelWriter;
  import org.apache.calcite.rel.core.Filter;
  import org.apache.calcite.rel.metadata.RelMetadataQuery;
  import org.apache.calcite.rex.RexNode;
  
  import com.alibaba.innodb.java.reader.schema.TableDef;
  
  import org.checkerframework.checker.nullness.qual.Nullable;
  
  import static java.util.Objects.requireNonNull;
  
  /**
   * Implementation of a {@link org.apache.calcite.rel.core.Filter}
   * relational expression for an InnoDB data source.
   */
  public class InnodbFilter extends Filter implements InnodbRel {
    private final TableDef tableDef;
    public final IndexCondition indexCondition;
    private final @Nullable String forceIndexName;
  
    /** Creates an InnodbFilter; but use {@link #create} if possible. */
    private InnodbFilter(RelOptCluster cluster, RelTraitSet traitSet,
        RelNode input, RexNode condition, IndexCondition indexCondition,
        TableDef tableDef, @Nullable String forceIndexName) {
      super(cluster, traitSet, input, condition);
  
      this.tableDef = requireNonNull(tableDef, "tableDef");
      this.indexCondition = requireNonNull(indexCondition, "indexCondition");
      this.forceIndexName = forceIndexName;
  
      assert getConvention() == InnodbRel.CONVENTION;
      assert getConvention() == input.getConvention();
    }
  
    /** Creates an InnodbFilter. */
    public static InnodbFilter create(RelOptCluster cluster, RelTraitSet traitSet,
        RelNode input, RexNode condition, IndexCondition indexCondition,
        TableDef tableDef, @Nullable String forceIndexName) {
      return new InnodbFilter(cluster, traitSet, input, condition, indexCondition,
          tableDef, forceIndexName);
    }
  
    @Override public @Nullable RelOptCost computeSelfCost(RelOptPlanner planner,
        RelMetadataQuery mq) {
      final RelOptCost cost = requireNonNull(super.computeSelfCost(planner, mq));
      return cost.multiplyBy(0.1);
    }
  
    @Override public InnodbFilter copy(RelTraitSet traitSet, RelNode input,
        RexNode condition) {
      return new InnodbFilter(getCluster(), traitSet, input, condition,
          indexCondition, tableDef, forceIndexName);
    }
  
    @Override public void implement(Implementor implementor) {
      implementor.visitChild(0, getInput());
      implementor.setIndexCondition(indexCondition);
    }
  
    @Override public RelWriter explainTerms(RelWriter pw) {
      pw.input("input", getInput());
      pw.itemIf("condition", indexCondition, indexCondition.canPushDown());
      return pw;
    }
  
    /**
     * Returns the resulting collation by the primary or secondary
     * indexes after filtering.
     *
     * @return the implicit collation based on the natural sorting by specific index
     */
    public RelCollation getImplicitCollation() {
      return indexCondition.getImplicitCollation();
    }
  }
  