flink-libraries/flink-table/src/main/scala/org/apache/flink/table/plan/metadata/FlinkRelMdPercentageOriginalRows.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.metadata

import org.apache.flink.table.plan.nodes.calcite.{Expand, Rank}
import org.apache.flink.table.plan.nodes.physical.batch.BatchExecGroupAggregateBase

import org.apache.calcite.plan.volcano.RelSubset
import org.apache.calcite.rel.RelNode
import org.apache.calcite.rel.core.{Aggregate, Join, SemiJoin, Union}
import org.apache.calcite.rel.metadata._
import org.apache.calcite.util.{BuiltInMethod, Util}

import java.lang.Double

import scala.collection.JavaConversions._

class FlinkRelMdPercentageOriginalRows private
  extends MetadataHandler[BuiltInMetadata.PercentageOriginalRows] {

  def getDef: MetadataDef[BuiltInMetadata.PercentageOriginalRows] =
    BuiltInMetadata.PercentageOriginalRows.DEF

  def getPercentageOriginalRows(rel: Aggregate, mq: RelMetadataQuery): Double =
    mq.getPercentageOriginalRows(rel.getInput)

  def getPercentageOriginalRows(rel: BatchExecGroupAggregateBase, mq: RelMetadataQuery): Double = {
    mq.getPercentageOriginalRows(rel.getInput)
  }

  /**
    * Catch-all rule when none of the others apply.
    */
  def getPercentageOriginalRows(rel: RelNode, mq: RelMetadataQuery): Double = {
    if (rel.getInputs.size > 1) {
      // No generic formula available for multiple inputs.
      return null
    }
    if (rel.getInputs.size == 0) {
      // Assume no filtering happening at leaf.
      return 1.0
    }
    val child = rel.getInputs.get(0)
    val childPercentage = mq.getPercentageOriginalRows(child)
    if (childPercentage == null) {
      return null
    }
    // Compute product of percentage filtering from this rel (assuming any
    // filtering is the effect of single-table filters) with the percentage
    // filtering performed by the child.
    val relPercentage = quotientForPercentage(mq.getRowCount(rel), mq.getRowCount(child))
    if (relPercentage == null) {
      return null
    }
    val percent = relPercentage * childPercentage
    if ((percent < 0.0) || (percent > 1.0)) {
      return null
    }
    relPercentage * childPercentage
  }

  def getPercentageOriginalRows(rel: Union, mq: RelMetadataQuery): Double = {
    var numerator: Double = 0.0
    var denominator: Double = 0.0
    rel.getInputs.foreach { input =>
      val rowCount = mq.getRowCount(input)
      val percentage = mq.getPercentageOriginalRows(input)
      if (percentage != null && percentage != 0.0) {
        denominator += rowCount / percentage
        numerator += rowCount
      }
    }
    quotientForPercentage(numerator, denominator)
  }

  def getPercentageOriginalRows(rel: Join, mq: RelMetadataQuery): Double = {
    val left: Double = mq.getPercentageOriginalRows(rel.getLeft)
    val right: Double = mq.getPercentageOriginalRows(rel.getRight)
    if (left == null || right == null) {
      null
    } else {
      left * right
    }
  }

  def getPercentageOriginalRows(rel: SemiJoin, mq: RelMetadataQuery): Double = {
    mq.getPercentageOriginalRows(rel.getLeft)
  }

  def getPercentageOriginalRows(rel: Expand, mq: RelMetadataQuery): Double = {
    mq.getPercentageOriginalRows(rel.getInput)
  }

  def getPercentageOriginalRows(rel: Rank, mq: RelMetadataQuery): Double = {
    mq.getPercentageOriginalRows(rel.getInput)
  }

  def getPercentageOriginalRows(subset: RelSubset, mq: RelMetadataQuery): Double = {
    mq.getPercentageOriginalRows(Util.first(subset.getBest, subset.getOriginal))
  }

  private def quotientForPercentage(numerator: Double, denominator: Double): Double = {
    if (numerator == null || denominator == null) {
      return null
    }
    // may need epsilon instead
    if (denominator == 0.0) {
      // cap at 100%
      1.0
    } else {
      numerator / denominator
    }
  }
}

object FlinkRelMdPercentageOriginalRows {

  private val INSTANCE = new FlinkRelMdPercentageOriginalRows

  val SOURCE: RelMetadataProvider = ReflectiveRelMetadataProvider.reflectiveSource(
        BuiltInMethod.PERCENTAGE_ORIGINAL_ROWS.method, INSTANCE)

}