DummyPlan.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.trees.plans;

import org.apache.doris.nereids.hint.DistributeHint;
import org.apache.doris.nereids.trees.AbstractTreeNode;
import org.apache.doris.nereids.util.TreeStringUtils;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

/**
 * Abstract class for leading hint plan node
 */
public abstract class DummyPlan extends AbstractTreeNode<DummyPlan> {
    public DummyPlan() {
    }

    public DummyPlan(List<DummyPlan> children) {
        super(children);
    }

    public abstract void collectParamsForLeadingHint(List<String> params, Map<String, DistributeHint> strToHint,
            List<String> errs);

    public String treeString() {
        return TreeStringUtils.treeString(this,
                plan -> plan.toString(),
                plan -> ((AbstractTreeNode) plan).children(),
                plan -> new ArrayList<>(),
                plan -> false);
    }
}