com.hazelcast.org.apache.calcite.plan.volcano.VolcanoPlannerPhaseRuleMappingInitializer 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.volcano;
import java.util.Map;
import java.util.Set;
/**
* VolcanoPlannerPhaseRuleMappingInitializer describes an interface for
* initializing the mapping of {@link VolcanoPlannerPhase}s to sets of rule
* descriptions.
*
* Note: Rule descriptions are obtained via
* {@link com.hazelcast.org.apache.calcite.plan.RelOptRule#toString()}. By default they are
* the class's simple name (e.g. class name sans package), unless the class is
* an inner class, in which case the default is the inner class's simple
* name. Some rules explicitly provide alternate descriptions by calling the
* {@link com.hazelcast.org.apache.calcite.plan.RelOptRule#RelOptRule(com.hazelcast.org.apache.calcite.plan.RelOptRuleOperand, String)}
* constructor.
*/
public interface VolcanoPlannerPhaseRuleMappingInitializer {
//~ Methods ----------------------------------------------------------------
/**
* Initializes a {@link VolcanoPlannerPhase}-to-rule map. Rules are
* specified by description (see above). When this method is called, the map
* will already be pre-initialized with empty sets for each
* VolcanoPlannerPhase. Implementations must not return having added or
* removed keys from the map, although it is safe to temporarily add or
* remove keys.
*
* @param phaseRuleMap a {@link VolcanoPlannerPhase}-to-rule map
*/
void initialize(Map> phaseRuleMap);
}