com.sparkutils.quality.impl.util.ComparableMapConverter.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quality_9.1.dbr_3.1_2.12 Show documentation
A Spark library for managing in-process data quality rules via Spark SQL
The newest version!
package com.sparkutils.quality.impl.util

import org.apache.spark.sql.Column
import org.apache.spark.sql.catalyst.expressions.codegen.CodegenFallback
import org.apache.spark.sql.catalyst.expressions.{BoundReference, Expression, UnaryExpression}
import org.apache.spark.sql.catalyst.util.{ArrayBasedMapData, ArrayData, MapData}
import org.apache.spark.sql.catalyst.{InternalRow, util}
import org.apache.spark.sql.qualityFunctions.utils
import org.apache.spark.sql.qualityFunctions.utils.{KeyValueArray, keyValueType}
import org.apache.spark.sql.types._


/**
 * Convert maps to sorted arrays of key value structs to allow comparison
 */
object ComparableMapConverter {

  def apply(child: Column, compareF: DataType => Option[(Any, Any) => Int] = (dataType: DataType) => utils.defaultMapCompare(dataType)): Column =
    new Column(ComparableMapConverter(child.expr, compareF))

  def deMapStruct(key: (DataType, Any => Any), value: (DataType, Any => Any), compareLookup: DataType => Option[(Any, Any) => Int]): (DataType, Any => Any) =
    (keyValueType(key._1, value._1), {
      def ensureType(dataType: DataType) =
        dataType match {
          // it it's our converted type we need to "extract" via MapType
          case KeyValueArray(key, value) => MapType(key, value, false)
          case _ => dataType
        }

      val actualKeyType = ensureType(key._1)
      val actualValueType = ensureType(value._1)

      val compareF = compareLookup(actualKeyType).getOrElse(
        sys.error(s"Could not identify the comparison function for type $actualKeyType to order keys")
      )
      // for the key type, expanded for 2.4, scala 2.11 support
      val comparisonOrdering: Ordering[Any] = new Ordering[Any] {
        override def compare(x: Any, y: Any): Int = compareF(x, y)
      }

      {
        case theMap: MapData =>

          // maps are already converted all the way down before trying to sort by key._2
          val sorted = Arrays.mapArray(theMap.keyArray(), actualKeyType, key._2).zipWithIndex.sortBy(_._1)(comparisonOrdering)
          val vals = {
            val valArray =theMap.valueArray()
            (idx: Int) => valArray.get(idx, actualValueType) //Arrays.toArray(theMap.valueArray(), actualValueType)
          }
          // now re-pack as structs
          ArrayData.toArrayData(sorted.map {
            case (tkey, index) =>
              InternalRow(tkey, value._2(vals(index)))
          })
        case e if e == null =>
          null
      }
    }
  )

  def deMapStruct(dataType: DataType, compareF: DataType => Option[(Any, Any) => Int]): (DataType, Any => Any) =
    dataType match {
      case mapType: MapType =>
        val key = deMapStruct(mapType.keyType, compareF)
        val value = deMapStruct(mapType.valueType, compareF)
        deMapStruct( key, value, compareF)
      case arrayType: ArrayType =>
        val r = deMapStruct(arrayType.elementType, compareF)
        (ArrayType(r._1),
          {
            case array: util.ArrayData =>
              ArrayData.toArrayData(
                Arrays.mapArray( array, arrayType.elementType, r._2 )
              )
            case e if e == null =>
              null
          }
        )
      case structType: StructType =>
        val fieldTransforms = structType.fields.zipWithIndex.map{
          case (f, index) =>
            val p = deMapStruct(f.dataType, compareF)
            // use original type to get
            (p._1, (a: InternalRow) => p._2(BoundReference(index, f.dataType, nullable = true).eval(a)))
        }

        // convert types
        (StructType(structType.fields.zip(fieldTransforms).map(p => p._1.copy(dataType = p._2._1))),
          { // convert data to target type
            case row: InternalRow =>
              InternalRow.fromSeq(fieldTransforms.map(_._2(row)))
            case e if e == null =>
              null
          }
        )
      case _ => (dataType, identity)
    }

  def mapStruct(key: (DataType, Any => Any), value: (DataType, Any => Any)): (DataType, Any => Any) =
    (MapType(key._1, value._1, false),
      {
        case theArray: ArrayData =>

          val keyr = BoundReference(0, key._1, nullable = true)
          val valuer = BoundReference(1, value._1, nullable = true)

          val theScalaMap =
            Arrays.mapArray(theArray, StructType(
              Seq(StructField("key", key._1, false), StructField("value", value._1, false))
            ), {
              case row: InternalRow =>
                (key._2(keyr.eval(row)), value._2(valuer.eval(row)))
            } ).map(_.asInstanceOf[(Any, Any)]).toMap

          ArrayBasedMapData(theScalaMap)
        case e if e == null =>
          null
      }
    )

  def mapStruct(dataType: DataType): (DataType, Any => Any) =
    dataType match {
      case KeyValueArray(keyType, valueType) =>
        val key = mapStruct(keyType)
        val value = mapStruct(valueType)
        mapStruct( key, value)
      case arrayType: ArrayType =>
        val r = mapStruct(arrayType.elementType)
        (ArrayType(r._1),
          {
            case array: util.ArrayData =>
              ArrayData.toArrayData(
                Arrays.mapArray( array, arrayType.elementType, r._2 )
              )
            case e if e == null =>
              null
          }
        )
      case structType: StructType =>
        val fieldTransforms = structType.fields.zipWithIndex.map{
          case (f, index) =>
            val p = mapStruct(f.dataType)
            // use original type to get
            (p._1, (a: InternalRow) => p._2(BoundReference(index, f.dataType, nullable = true).eval(a)))
        }

        // convert types
        (StructType(structType.fields.zip(fieldTransforms).map(p => p._1.copy(dataType = p._2._1))),
          { // convert data to target type
            case row: InternalRow =>
              InternalRow.fromSeq(fieldTransforms.map(_._2(row)))
            case e if e == null =>
              null
          }
        )
      case _ => (dataType, identity)
    }
}

/**
 * Convert's structures from child replacing all Map's with ordered arrays.
 *
 * Order is provided by registerQualityFunctions compare parameter.
 *
 * @param child the child expression e.g. a quality result
 * @param compareF the compare lookup function
 */
case class ComparableMapConverter(child: Expression, compareF: DataType => Option[(Any, Any) => Int]) extends UnaryExpression with CodegenFallback {

  lazy val (theType, theFunction) = ComparableMapConverter.deMapStruct(child.dataType, compareF: DataType => Option[(Any, Any) => Int])

  override def dataType: DataType = theType

  override def nullSafeEval(input: Any): Any = theFunction(input)

  protected def withNewChildInternal(newChild: Expression): Expression = copy(child = newChild)
}

/**
 * Reverts the ComparableMapConverter
 *
 * @param child the child expression e.g. a quality result
 */
case class ComparableMapReverser(child: Expression) extends UnaryExpression with CodegenFallback {

  lazy val (theType, theFunction) = ComparableMapConverter.mapStruct(child.dataType)

  override def dataType: DataType = theType

  override def nullSafeEval(input: Any): Any = theFunction(input)

  protected def withNewChildInternal(newChild: Expression): Expression = copy(child = newChild)
}