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.geode.rel;
  
  import org.apache.calcite.plan.RelOptCluster;
  import org.apache.calcite.plan.RelOptPlanner;
  import org.apache.calcite.plan.RelOptRule;
  import org.apache.calcite.plan.RelOptTable;
  import org.apache.calcite.plan.RelTraitSet;
  import org.apache.calcite.rel.RelNode;
  import org.apache.calcite.rel.core.TableScan;
  import org.apache.calcite.rel.type.RelDataType;
  
  import com.google.common.collect.ImmutableList;
  
  import org.checkerframework.checker.nullness.qual.Nullable;
  
  import java.util.List;
  
  import static com.google.common.base.Preconditions.checkArgument;
  
  import static java.util.Objects.requireNonNull;
  
  /**
   * Relational expression representing a scan of a Geode collection.
   */
  public class GeodeTableScan extends TableScan implements GeodeRel {
  
    final GeodeTable geodeTable;
    final @Nullable RelDataType projectRowType;
  
    /**
     * Creates a GeodeTableScan.
     *
     * @param cluster        Cluster
     * @param traitSet       Traits
     * @param table          Table
     * @param geodeTable     Geode table
     * @param projectRowType Fields and types to project; null to project raw row
     */
    GeodeTableScan(RelOptCluster cluster, RelTraitSet traitSet,
        RelOptTable table, GeodeTable geodeTable,
        @Nullable RelDataType projectRowType) {
      super(cluster, traitSet, ImmutableList.of(), table);
      this.geodeTable = requireNonNull(geodeTable, "geodeTable");
      this.projectRowType = projectRowType;
  
      checkArgument(getConvention() == GeodeRel.CONVENTION);
    }
  
    @Override public RelNode copy(RelTraitSet traitSet, List<RelNode> inputs) {
      assert inputs.isEmpty();
      return this;
    }
  
    @Override public RelDataType deriveRowType() {
      return projectRowType != null ? projectRowType : super.deriveRowType();
    }
  
    @Override public void register(RelOptPlanner planner) {
      planner.addRule(GeodeToEnumerableConverterRule.INSTANCE);
      for (RelOptRule rule : GeodeRules.RULES) {
        planner.addRule(rule);
      }
    }
  
    @Override public void implement(GeodeImplementContext geodeImplementContext) {
      // Note: Scan is the leaf and we do NOT visit its inputs
      geodeImplementContext.geodeTable = geodeTable;
      geodeImplementContext.table = table;
    }
  }
  