FileRules.java

/*
 * 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.file;

/** Planner rules relating to the File adapter. */
public abstract class FileRules {
  private FileRules() {}

  /** Rule that matches a {@link org.apache.calcite.rel.core.Project} on
   * a {@link CsvTableScan} and pushes down projects if possible. */
  public static final CsvProjectTableScanRule PROJECT_SCAN =
      CsvProjectTableScanRule.Config.DEFAULT.toRule();

  /** Rule that matches a {@link org.apache.calcite.rel.core.Filter} on
   * a {@link CsvTableScan} and pushes arbitrary predicates into the scan.
   * Any {@link org.apache.calcite.rex.RexNode} condition is compiled at plan
   * time via {@link org.apache.calcite.adapter.enumerable.RexToLixTranslator}
   * into a {@link org.apache.calcite.linq4j.function.Predicate1}. */
  public static final CsvFilterTableScanRule FILTER_SCAN =
      CsvFilterTableScanRule.Config.DEFAULT.toRule();

  /** Rule that matches a {@link org.apache.calcite.rel.core.Project} on
   * a {@link org.apache.calcite.rel.core.Filter} on a {@link CsvTableScan},
   * pushes the filter condition into the scan, and remaps project and filter
   * input references to match the scan's new projection. */
  public static final CsvProjectFilterTableScanRule PROJECT_FILTER_SCAN =
      CsvProjectFilterTableScanRule.Config.DEFAULT.toRule();
}