com.hazelcast.org.apache.calcite.plan.RelTraitPropagationVisitor 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 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 com.hazelcast.org.apache.calcite.plan;
import com.hazelcast.org.apache.calcite.rel.RelNode;
import com.hazelcast.org.apache.calcite.rel.RelVisitor;
import com.hazelcast.org.apache.calcite.util.Util;
import com.hazelcast.org.checkerframework.checker.nullness.qual.Nullable;
/**
* RelTraitPropagationVisitor traverses a RelNode and its unregistered
* children, making sure that each has a full complement of traits. When a
* RelNode is found to be missing one or more traits, they are copied from a
* RelTraitSet given during construction.
*
* @deprecated As of 1.19, if you need to perform certain assertions regarding a RelNode tree and
* the contained traits you are encouraged to implement your own RelVisitor or
* {@link com.hazelcast.org.apache.calcite.rel.RelShuttle} directly. The reasons for deprecating this class are
* the following:
*
* - The contract (Javadoc and naming) and the behavior of the class are inconsistent.
* - The class is no longer used by any other components of the framework.
* - The class was used only for debugging purposes.
*
*
*/
@Deprecated
public class RelTraitPropagationVisitor extends RelVisitor {
//~ Instance fields --------------------------------------------------------
private final RelTraitSet baseTraits;
private final RelOptPlanner planner;
//~ Constructors -----------------------------------------------------------
public RelTraitPropagationVisitor(
RelOptPlanner planner,
RelTraitSet baseTraits) {
this.planner = planner;
this.baseTraits = baseTraits;
}
//~ Methods ----------------------------------------------------------------
@Override public void visit(RelNode rel, int ordinal, @Nullable RelNode parent) {
// REVIEW: SWZ: 1/31/06: We assume that any special RelNodes, such
// as the VolcanoPlanner's RelSubset always have a full complement
// of traits and that they either appear as registered or do nothing
// when childrenAccept is called on them.
if (planner.isRegistered(rel)) {
return;
}
RelTraitSet relTraits = rel.getTraitSet();
for (int i = 0; i < baseTraits.size(); i++) {
if (i >= relTraits.size()) {
// Copy traits that the new rel doesn't know about.
Util.discard(
RelOptUtil.addTrait(
rel,
baseTraits.getTrait(i)));
// FIXME: Return the new rel. We can no longer traits in-place,
// because rels and traits are immutable.
throw new AssertionError();
} else {
// Verify that the traits are from the same RelTraitDef
assert relTraits.getTrait(i).getTraitDef()
== baseTraits.getTrait(i).getTraitDef();
}
}
rel.childrenAccept(this);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy