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

import org.apache.calcite.sql.SqlFunctionalOperator;
import org.apache.calcite.sql.SqlKind;
import org.apache.calcite.sql.type.OperandTypes;
import org.apache.calcite.sql.type.ReturnTypes;
import org.apache.calcite.sql.validate.SqlModality;

/**
 * SqlCollectionTableOperator is the "table function derived table" operator. It
 * converts a table-valued function into a relation, e.g. "<code>SELECT * FROM
 * TABLE(ramp(5))</code>".
 *
 * <p>This operator has function syntax (with one argument), whereas
 * {@link SqlStdOperatorTable#EXPLICIT_TABLE} is a prefix operator.
 */
public class SqlCollectionTableOperator extends SqlFunctionalOperator {
  private final SqlModality modality;
  private final String aliasName;


  //~ Constructors -----------------------------------------------------------

  public SqlCollectionTableOperator(String name, SqlModality modality) {
    super(name, SqlKind.COLLECTION_TABLE, 200, true, ReturnTypes.ARG0, null,
            OperandTypes.CURSOR);
    this.modality = modality;
    this.aliasName = null;
  }

  public SqlCollectionTableOperator(String name, SqlModality modality, String aliasName) {
    super(name, SqlKind.COLLECTION_TABLE, 200, true, ReturnTypes.ARG0, null,
            OperandTypes.ANY);
    this.modality = modality;
    this.aliasName = aliasName;
  }

  //~ Methods ----------------------------------------------------------------

  public SqlModality getModality() {
    return modality;
  }

  public String getAliasName() {
    return aliasName;
  }
}
