com.hazelcast.org.apache.calcite.schema.ProjectableFilterableTable Maven / Gradle / Ivy
/*
* 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 com.hazelcast.com.liance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.com.hazelcast.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 com.hazelcast.org.apache.calcite.schema;
import com.hazelcast.org.apache.calcite.DataContext;
import com.hazelcast.org.apache.calcite.linq4j.Enumerable;
import com.hazelcast.org.apache.calcite.rex.RexNode;
import java.util.List;
/**
* Table that can be scanned, optionally applying supplied filter expressions,
* and projecting a given list of columns,
* without creating an intermediate relational expression.
*
* If you wish to write a table that can apply projects but not filters,
* simply decline all filters.
*
* @see ScannableTable
* @see FilterableTable
*/
public interface ProjectableFilterableTable extends Table {
/** Returns an enumerable over the rows in this Table.
*
* Each row is represented as an array of its column values.
*
*
The list of filters is mutable.
* If the table can implement a particular filter, it should remove that
* filter from the list.
* If it cannot implement a filter, it should leave it in the list.
* Any filters remaining will be implemented by the consuming Calcite
* operator.
*
*
The projects are zero-based.
*
* @param root Execution context
* @param filters Mutable list of filters. The method should keep in the
* list any filters that it cannot apply.
* @param projects List of projects. Each is the 0-based ordinal of the column
* to project.
* @return Enumerable over all rows that match the accepted filters, returning
* for each row an array of column values, one value for each ordinal in
* {@code projects}.
*/
Enumerable scan(DataContext root, List filters,
int[] projects);
}