wayang-commons/wayang-core/src/main/java/org/apache/wayang/core/optimizer/enumeration/PlanEnumerationPruningStrategy.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.wayang.core.optimizer.enumeration;

import org.apache.wayang.core.api.Configuration;

/**
 * A strategy to prune {@link PlanImplementation}s from a {@link PlanEnumeration}.
 */
public interface PlanEnumerationPruningStrategy {

    /**
     * Configure this instance. Should be called (once) before using {@link #prune(PlanEnumeration)}.
     *
     * @param configuration provides configuration values
     */
    void configure(Configuration configuration);

    /**
     * Prune down the {@link PlanEnumeration}, i.e., remove some of its {@link PlanImplementation}s.
     *
     * @param planEnumeration to be pruned
     */
    void prune(PlanEnumeration planEnumeration);
}