VisitorDataContext.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.plan;
import org.apache.calcite.DataContext;
import org.apache.calcite.adapter.java.JavaTypeFactory;
import org.apache.calcite.linq4j.QueryProvider;
import org.apache.calcite.rel.RelNode;
import org.apache.calcite.rel.logical.LogicalFilter;
import org.apache.calcite.rel.type.RelDataType;
import org.apache.calcite.rex.RexCall;
import org.apache.calcite.rex.RexInputRef;
import org.apache.calcite.rex.RexLiteral;
import org.apache.calcite.rex.RexNode;
import org.apache.calcite.rex.RexUtil;
import org.apache.calcite.schema.SchemaPlus;
import org.apache.calcite.util.DateString;
import org.apache.calcite.util.NlsString;
import org.apache.calcite.util.Pair;
import org.apache.calcite.util.TimeString;
import org.apache.calcite.util.TimestampString;
import org.apache.calcite.util.trace.CalciteLogger;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.slf4j.LoggerFactory;
import java.math.BigDecimal;
import java.util.List;
import static java.util.Objects.requireNonNull;
/**
* DataContext for evaluating a RexExpression.
*/
public class VisitorDataContext implements DataContext {
private static final CalciteLogger LOGGER =
new CalciteLogger(LoggerFactory.getLogger(VisitorDataContext.class.getName()));
private final @Nullable Object[] values;
public VisitorDataContext(@Nullable Object[] values) {
this.values = values;
}
@Override public SchemaPlus getRootSchema() {
throw new RuntimeException("Unsupported");
}
@Override public JavaTypeFactory getTypeFactory() {
throw new RuntimeException("Unsupported");
}
@Override public QueryProvider getQueryProvider() {
throw new RuntimeException("Unsupported");
}
@Override public @Nullable Object get(String name) {
if (name.equals("inputRecord")) {
return values;
} else {
return null;
}
}
public static @Nullable DataContext of(RelNode targetRel, LogicalFilter queryRel) {
return of(targetRel.getRowType(), queryRel.getCondition());
}
public static @Nullable DataContext of(RelDataType rowType, RexNode rex) {
final int size = rowType.getFieldList().size();
final List<RexNode> operands = ((RexCall) rex).getOperands();
final RexNode firstOperand = operands.get(0);
final RexNode secondOperand = operands.get(1);
final Pair<Integer, ?> value = getValue(firstOperand, secondOperand);
if (value != null) {
final @Nullable Object[] values = new Object[size];
int index = value.getKey();
values[index] = value.getValue();
return new VisitorDataContext(values);
} else {
return null;
}
}
public static @Nullable DataContext of(RelDataType rowType,
List<? extends Pair<RexInputRef, ? extends @Nullable RexNode>> usageList) {
final int size = rowType.getFieldList().size();
final @Nullable Object[] values = new Object[size];
for (Pair<RexInputRef, ? extends @Nullable RexNode> elem : usageList) {
Pair<Integer, ?> value = getValue(elem.getKey(), elem.getValue());
if (value == null) {
LOGGER.warn("{} is not handled for {} for checking implication",
elem.getKey(), elem.getValue());
return null;
}
int index = value.getKey();
values[index] = value.getValue();
}
return new VisitorDataContext(values);
}
/**
* Extracts a value from a RexLiteral for use in DataContext.
*
* <p>Returns a Pair of (column index, value) if extraction is successful,
* or null if the value cannot be extracted or is invalid.
*
* <p>Returns null when:
* <ul>
* <li>Arguments are not valid RexInputRef and RexLiteral</li>
* <li>Type conversion fails (e.g., invalid date/time format)</li>
* <li>Type combination is unsupported</li>
* </ul>
*
* <p>When null is returned, the containing optimization (e.g.,
* materialized view substitution) cannot be applied and is skipped.
*
* @param inputRef the input reference (column)
* @param literal the literal value to extract
* @return a Pair of (column index, value) or null
*/
public static @Nullable Pair<Integer, ? extends @Nullable Object> getValue(
@Nullable RexNode inputRef, @Nullable RexNode literal) {
inputRef = inputRef == null ? null : RexUtil.removeCast(inputRef);
literal = literal == null ? null : RexUtil.removeCast(literal);
if (inputRef instanceof RexInputRef
&& literal instanceof RexLiteral) {
final int index = ((RexInputRef) inputRef).getIndex();
final RexLiteral rexLiteral = (RexLiteral) literal;
final RelDataType type = inputRef.getType();
if (type.getSqlTypeName() == null) {
LOGGER.warn("{} returned null SqlTypeName", inputRef.toString());
return null;
}
switch (type.getSqlTypeName()) {
case INTEGER:
return Pair.of(index, rexLiteral.getValueAs(Integer.class));
case FLOAT:
case DOUBLE:
return Pair.of(index, rexLiteral.getValueAs(Double.class));
case REAL:
return Pair.of(index, rexLiteral.getValueAs(Float.class));
case BIGINT:
return Pair.of(index, rexLiteral.getValueAs(Long.class));
case SMALLINT:
return Pair.of(index, rexLiteral.getValueAs(Short.class));
case TINYINT:
return Pair.of(index, rexLiteral.getValueAs(Byte.class));
case DECIMAL:
return Pair.of(index, rexLiteral.getValueAs(BigDecimal.class));
case DATE:
switch (rexLiteral.getType().getSqlTypeName()) {
case DATE:
return Pair.of(index, rexLiteral.getValueAs(Integer.class));
case CHAR:
case VARCHAR:
try {
return Pair.of(index,
new DateString(requireNonNull(rexLiteral.getValueAs(String.class)))
.getDaysSinceEpoch());
} catch (IllegalArgumentException e) {
LOGGER.warn(
"Cannot convert string literal '{}' to DATE type; "
+ "materialized view optimization will be skipped",
rexLiteral.getValueAs(String.class), e);
return null;
}
default:
break;
}
break;
case TIME:
switch (rexLiteral.getType().getSqlTypeName()) {
case TIME:
return Pair.of(index, rexLiteral.getValueAs(Integer.class));
case CHAR:
case VARCHAR:
try {
return Pair.of(index,
new TimeString(requireNonNull(rexLiteral.getValueAs(String.class)))
.getMillisOfDay());
} catch (IllegalArgumentException e) {
LOGGER.debug(
"Cannot convert string literal '{}' to TIME type; "
+ "materialized view optimization will be skipped",
rexLiteral.getValueAs(String.class), e);
return null;
}
default:
break;
}
break;
case TIMESTAMP:
switch (rexLiteral.getType().getSqlTypeName()) {
case TIMESTAMP:
return Pair.of(index, rexLiteral.getValueAs(Long.class));
case CHAR:
case VARCHAR:
try {
return Pair.of(index,
new TimestampString(requireNonNull(rexLiteral.getValueAs(String.class)))
.getMillisSinceEpoch());
} catch (IllegalArgumentException e) {
LOGGER.debug(
"Cannot convert string literal '{}' to TIMESTAMP type; "
+ "materialized view optimization will be skipped",
rexLiteral.getValueAs(String.class), e);
return null;
}
default:
break;
}
break;
case CHAR:
return Pair.of(index, rexLiteral.getValueAs(Character.class));
case VARCHAR:
return Pair.of(index, rexLiteral.getValueAs(String.class));
default:
// TODO: Support few more supported cases
Comparable value = rexLiteral.getValue();
LOGGER.warn("{} for value of class {} is being handled in default way",
type.getSqlTypeName(), value == null ? null : value.getClass());
if (value instanceof NlsString) {
return Pair.of(index, ((NlsString) value).getValue());
} else {
return Pair.of(index, value);
}
}
}
// Unsupported Arguments
return null;
}
}