org.apache.calcite.sql.SqlProperty Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of calcite-core Show documentation

Core Calcite APIs and engine.

There is a newer version: 1.17.0-flink-r3

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

import org.apache.calcite.sql.parser.SqlParserPos;
import org.apache.calcite.util.NlsString;

import com.google.common.collect.ImmutableList;

import java.util.List;

import static java.util.Objects.requireNonNull;

/**
 * Properties of a DDL, consist of key value pairs.
 */
public class SqlProperty extends SqlCall {

  /** Use this operator only if you don't have a better one. */
  protected static final SqlOperator OPERATOR =
          new SqlSpecialOperator("Property", SqlKind.OTHER);

  private SqlIdentifier key;
  private SqlNode value;

  public SqlProperty(SqlIdentifier key, SqlNode value, SqlParserPos pos) {
    super(pos);
    this.key = requireNonNull(key, "Property key is missing");
    this.value = requireNonNull(value, "Property value is missing");
  }

  public SqlIdentifier getKey() {
    return key;
  }

  public SqlNode getValue() {
    return value;
  }

  public String getKeyString() {
    return key.toString();
  }

  public String getValueString() {
    return ((NlsString) SqlLiteral.value(value)).getValue();
  }

  @Override public SqlOperator getOperator() {
    return OPERATOR;
  }

  @Override public List getOperandList() {
    return ImmutableList.of(key, value);
  }

  public void unparse(
      SqlWriter writer,
      int leftPrec,
      int rightPrec) {
    key.unparse(writer, leftPrec, rightPrec);
    writer.keyword("=");
    value.unparse(writer, leftPrec, rightPrec);
  }
}
// End SqlProperty.java