MatchRule.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.calcite.rel.rules;

import org.apache.calcite.plan.RelOptRuleCall;
import org.apache.calcite.plan.RelRule;
import org.apache.calcite.rel.RelNode;
import org.apache.calcite.rel.logical.LogicalMatch;

import org.immutables.value.Value;

/**
 * Planner rule that converts a
 * {@link LogicalMatch} to the result
 * of calling {@link LogicalMatch#copy}.
 *
 * @see CoreRules#MATCH
 */
@Value.Enclosing
public class MatchRule extends RelRule<MatchRule.Config>
    implements TransformationRule {

  /** Creates a MatchRule. */
  protected MatchRule(Config config) {
    super(config);
  }

  //~ Methods ----------------------------------------------------------------

  @Override public void onMatch(RelOptRuleCall call) {
    final LogicalMatch oldRel = call.rel(0);
    final RelNode match =
        LogicalMatch.create(oldRel.getCluster(), oldRel.getTraitSet(),
            oldRel.getInput(), oldRel.getRowType(),
            oldRel.getPattern(), oldRel.isStrictStart(), oldRel.isStrictEnd(),
            oldRel.getPatternDefinitions(), oldRel.getMeasures(),
            oldRel.getAfter(), oldRel.getSubsets(), oldRel.isAllRows(),
            oldRel.getPartitionKeys(), oldRel.getOrderKeys(),
            oldRel.getInterval());
    call.transformTo(match);
  }

  /** Rule configuration. */
  @Value.Immutable
  public interface Config extends RelRule.Config {
    Config DEFAULT = ImmutableMatchRule.Config.of()
        .withOperandSupplier(b -> b.operand(LogicalMatch.class).anyInputs());

    @Override default MatchRule toRule() {
      return new MatchRule(this);
    }
  }
}