flink-libraries/flink-table/src/main/scala/org/apache/flink/table/plan/nodes/logical/FlinkLogicalTemporalTableJoin.scala

/*
 * 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.flink.table.plan.nodes.logical

import org.apache.calcite.plan._
import org.apache.calcite.rel.RelNode
import org.apache.calcite.rel.convert.ConverterRule
import org.apache.calcite.rel.core._
import org.apache.calcite.rex.RexNode
import org.apache.flink.table.plan.logical.rel.LogicalTemporalTableJoin
import org.apache.flink.table.plan.nodes.FlinkConventions
import org.apache.flink.util.Preconditions.checkArgument

/**
  * Represents a join between a table and
  * [[org.apache.flink.table.functions.TemporalTableFunction]]. For more details please check
  * [[LogicalTemporalTableJoin]].
  */
class FlinkLogicalTemporalTableJoin(
    cluster: RelOptCluster,
    traitSet: RelTraitSet,
    left: RelNode,
    right: RelNode,
    condition: RexNode)
  extends FlinkLogicalJoinBase(
    cluster,
    traitSet,
    left,
    right,
    condition,
    JoinRelType.INNER) {

  def copy(
      traitSet: RelTraitSet,
      condition: RexNode,
      left: RelNode,
      right: RelNode,
      joinType: JoinRelType,
      semiJoinDone: Boolean): FlinkLogicalTemporalTableJoin = {
    checkArgument(joinType == this.getJoinType,
      "Can not change join type".asInstanceOf[Object])
    checkArgument(semiJoinDone == this.isSemiJoinDone,
      "Can not change semiJoinDone".asInstanceOf[Object])
    new FlinkLogicalTemporalTableJoin(
      cluster,
      traitSet,
      left,
      right,
      condition)
  }
}

class FlinkLogicalTemporalTableJoinConverter
  extends ConverterRule(
    classOf[LogicalTemporalTableJoin],
    Convention.NONE,
    FlinkConventions.LOGICAL,
    "FlinkLogicalTemporalTableJoinConverter") {

  override def matches(call: RelOptRuleCall): Boolean = {
    true
  }

  override def convert(rel: RelNode): RelNode = {
    val temporalTableJoin = rel.asInstanceOf[LogicalTemporalTableJoin]
    val traitSet = rel.getTraitSet.replace(FlinkConventions.LOGICAL)
    val newLeft = RelOptRule.convert(temporalTableJoin.getLeft, FlinkConventions.LOGICAL)
    val newRight = RelOptRule.convert(temporalTableJoin.getRight, FlinkConventions.LOGICAL)

    new FlinkLogicalTemporalTableJoin(
      rel.getCluster,
      traitSet,
      newLeft,
      newRight,
      temporalTableJoin.getCondition)
  }
}

object FlinkLogicalTemporalTableJoin {
  val CONVERTER = new FlinkLogicalTemporalTableJoinConverter
}