RequirePropertiesSupplier.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.doris.nereids.properties;

import org.apache.doris.nereids.exceptions.AnalysisException;
import org.apache.doris.nereids.properties.RequireProperties.RequirePropertiesTree;
import org.apache.doris.nereids.trees.plans.Plan;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;

import java.util.List;

/** RequirePropertiesSupplier */
public interface RequirePropertiesSupplier<P extends Plan> {
    List<Plan> children();

    RequireProperties getRequireProperties();

    Plan withRequireAndChildren(RequireProperties requireProperties, List<Plan> children);

    default P withRequire(RequireProperties requireProperties) {
        return (P) withRequireAndChildren(requireProperties, children());
    }

    /** withRequireTree */
    default P withRequireTree(RequirePropertiesTree tree) {
        List<RequirePropertiesTree> childrenRequires = tree.children;
        List<Plan> children = children();
        if (!childrenRequires.isEmpty() && children.size() != childrenRequires.size()) {
            throw new AnalysisException("The number of RequireProperties mismatch the plan tree");
        }

        List<Plan> newChildren = children;
        if (!childrenRequires.isEmpty()) {
            ImmutableList.Builder<Plan> newChildrenBuilder =
                    ImmutableList.builderWithExpectedSize(childrenRequires.size());
            for (int i = 0; i < children.size(); i++) {
                Plan child = children.get(i);
                Preconditions.checkState(child instanceof RequirePropertiesSupplier,
                        "child should be RequirePropertiesTree: " + child);
                Plan newChild = ((RequirePropertiesSupplier<Plan>) child).withRequireTree(childrenRequires.get(i));
                newChildrenBuilder.add(newChild);
            }
            newChildren = newChildrenBuilder.build();
        }

        return (P) withRequireAndChildren(tree.requireProperties, newChildren);
    }
}