Packages

o

org.checkita.dqf.core.metrics.df.regular

BasicNumericDFMetrics

object BasicNumericDFMetrics

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BasicNumericDFMetrics
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class AvgNumberDFMetricCalculator(metricId: String, columns: Seq[String]) extends DFMetricCalculator with Product with Serializable

    Calculates mean (average) value of provided elements

    Calculates mean (average) value of provided elements

    Works for single column only!

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    Note

    Null values are omitted: For values: "3", "7", null Metric result would be: (3 + 7) / 2 = 5

  2. case class CastedNumberDFMetricCalculator(metricId: String, columns: Seq[String], reversed: Boolean) extends ConditionalDFCalculator with Product with Serializable

    Calculates amount of element that can be cast to numerical (double format)

    Calculates amount of element that can be cast to numerical (double format)

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  3. case class FirstQuantileDFMetricCalculator(metricId: String, columns: Seq[String], accuracyError: Double) extends PercentileDFCalculator with Product with Serializable

    Calculates first quantile for provided elements

    Calculates first quantile for provided elements

    Works for single column only!

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    accuracyError

    Required level of calculation accuracy

  4. case class FormattedNumberDFMetricCalculator(metricId: String, columns: Seq[String], precision: Int, scale: Int, compareRule: String, reversed: Boolean) extends ConditionalDFCalculator with Product with Serializable

    Calculates amount of elements that fit (or do not fit) provided Decimal format: Decimal(precision, scale)

    Calculates amount of elements that fit (or do not fit) provided Decimal format: Decimal(precision, scale)

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    precision

    Precision threshold

    scale

    Required scale

    compareRule

    Either "inbound" or "outbound": defines wither number should fit within provided decimal format or to be outside of the provided precision and scale

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  5. case class GetPercentileDFMetricCalculator(metricId: String, columns: Seq[String], accuracyError: Double, target: Double) extends PercentileDFCalculator with Product with Serializable

    Calculates percentage value for given percentile value out of provided elements

    Calculates percentage value for given percentile value out of provided elements

    Works for single column only!

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    accuracyError

    Required level of calculation accuracy

    target

    Percentile value from set of column values.

  6. case class GetQuantileDFMetricCalculator(metricId: String, columns: Seq[String], accuracyError: Double, target: Double) extends PercentileDFCalculator with Product with Serializable

    Calculates arbitrary percentile for provided elements

    Calculates arbitrary percentile for provided elements

    Works for single column only!

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    accuracyError

    Required level of calculation accuracy

    target

    Percentage value for which percentile value is determined.

  7. case class MaxNumberDFMetricCalculator(metricId: String, columns: Seq[String]) extends DFMetricCalculator with Product with Serializable

    Calculates maximum numeric value for provided elements

    Calculates maximum numeric value for provided elements

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

  8. case class MedianValueDFMetricCalculator(metricId: String, columns: Seq[String], accuracyError: Double) extends PercentileDFCalculator with Product with Serializable

    Calculates median value for provided elements

    Calculates median value for provided elements

    Works for single column only!

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    accuracyError

    Required level of calculation accuracy

  9. case class MinNumberDFMetricCalculator(metricId: String, columns: Seq[String]) extends DFMetricCalculator with Product with Serializable

    Calculates minimal numeric value for provided elements

    Calculates minimal numeric value for provided elements

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

  10. case class NumberBetweenDFMetricCalculator(metricId: String, columns: Seq[String], lowerCompareValue: Double, upperCompareValue: Double, includeBound: Boolean, reversed: Boolean) extends ConditionalDFCalculator with NumberCriteriaRepr with Product with Serializable

    Calculates count of rows for which column value is within the lowerCompareValue:upperCompareValue interval

    Calculates count of rows for which column value is within the lowerCompareValue:upperCompareValue interval

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    lowerCompareValue

    Target lower interval bound to compare with

    upperCompareValue

    Target upper interval bound to compare with

    includeBound

    Flag which sets whether compareValue is included or excluded from the interval

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  11. trait NumberCriteriaRepr extends AnyRef

    Trait to be mixed to Number comparison metrics: defines standard error message for these types of metrics.

  12. case class NumberGreaterThanDFMetricCalculator(metricId: String, columns: Seq[String], compareValue: Double, includeBound: Boolean, reversed: Boolean) extends ConditionalDFCalculator with NumberCriteriaRepr with Product with Serializable

    Calculates count of rows for which column value is greater than compareValue

    Calculates count of rows for which column value is greater than compareValue

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    compareValue

    Target value to compare with

    includeBound

    Flag which sets whether compareValue is included or excluded from the interval

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  13. case class NumberInDomainDFMetricCalculator(metricId: String, columns: Seq[String], domain: Set[Double], reversed: Boolean) extends ConditionalDFCalculator with Product with Serializable

    Calculated amount of numbers in provided domain set

    Calculated amount of numbers in provided domain set

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    domain

    Set of numbers that represents the requested domain

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  14. case class NumberLessThanDFMetricCalculator(metricId: String, columns: Seq[String], compareValue: Double, includeBound: Boolean, reversed: Boolean) extends ConditionalDFCalculator with NumberCriteriaRepr with Product with Serializable

    Calculates count of rows for which column value is less than compareValue

    Calculates count of rows for which column value is less than compareValue

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    compareValue

    Target value to compare with

    includeBound

    Flag which sets whether compareValue is included or excluded from the interval

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  15. case class NumberNotBetweenDFMetricCalculator(metricId: String, columns: Seq[String], lowerCompareValue: Double, upperCompareValue: Double, includeBound: Boolean, reversed: Boolean) extends ConditionalDFCalculator with NumberCriteriaRepr with Product with Serializable

    Calculates count of rows for which column value is not within the lowerCompareValue:upperCompareValue interval

    Calculates count of rows for which column value is not within the lowerCompareValue:upperCompareValue interval

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    lowerCompareValue

    Target lower interval bound to compare with

    upperCompareValue

    Target upper interval bound to compare with

    includeBound

    Flag which sets whether compareValue is included or excluded from the interval

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  16. case class NumberOutDomainDFMetricCalculator(metricId: String, columns: Seq[String], domain: Set[Double], reversed: Boolean) extends ConditionalDFCalculator with Product with Serializable

    Calculated amount of numbers that are out of provided domain set

    Calculated amount of numbers that are out of provided domain set

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    domain

    Set of numbers that represents the requested domain

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  17. case class NumberValuesDFMetricCalculator(metricId: String, columns: Seq[String], compareValue: Double, reversed: Boolean) extends ConditionalDFCalculator with Product with Serializable

    Counts number of appearances of requested number in processed elements

    Counts number of appearances of requested number in processed elements

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    compareValue

    Requested number to find

    reversed

    Boolean flag indicating whether error collection logic should be reversed for this metric

  18. abstract class PercentileDFCalculator extends DFMetricCalculator

    Base class for all metrics thad compute percentiles based on T-Digest.

  19. case class StdNumberDFMetricCalculator(metricId: String, columns: Seq[String]) extends DFMetricCalculator with Product with Serializable

    Calculates standard deviation calculated from provided elements

    Calculates standard deviation calculated from provided elements

    Works for single column only!

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    Note

    Null values are omitted.

    ,

    Computes population standard deviation.

  20. case class SumNumberDFMetricCalculator(metricId: String, columns: Seq[String]) extends DFMetricCalculator with Product with Serializable

    Calculates sum of provided elements

    Calculates sum of provided elements

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

  21. case class ThirdQuantileDFMetricCalculator(metricId: String, columns: Seq[String], accuracyError: Double) extends PercentileDFCalculator with Product with Serializable

    Calculates third quantile for provided elements

    Calculates third quantile for provided elements

    Works for single column only!

    metricId

    Id of the metric.

    columns

    Sequence of columns which are used for metric calculation

    accuracyError

    Required level of calculation accuracy

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped