Object/Class

com.github.timgent.dataflare.checks.metrics

SingleMetricCheck

Related Docs: class SingleMetricCheck | package metrics

Permalink

object SingleMetricCheck extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SingleMetricCheck
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def complianceCheck(threshold: AbsoluteThreshold[Double], complianceFn: ComplianceFn, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[DoubleMetric]

    Permalink

    Checks the fraction of rows that are compliant with the given complianceFn

    Checks the fraction of rows that are compliant with the given complianceFn

    threshold

    - the threshold for what fraction of rows is acceptable

    complianceFn

    - the function rows are tested with to see if they are compliant

    filter

    - the filter that is applied before the compliance fraction is calculated

  7. def distinctValuesCheck(threshold: AbsoluteThreshold[Long], onColumns: List[String], filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[LongMetric]

    Permalink

    Checks the number of distinct values across the given columns

    Checks the number of distinct values across the given columns

    threshold

    - the threshold for what number of distinct values is acceptable

    onColumns

    - the columns to check for distinct values in

    filter

    - the filter that is applied before the distinct value count is done

  8. def distinctnessCheck(threshold: AbsoluteThreshold[Double], onColumns: List[String], filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[DoubleMetric]

    Permalink

    Checks the distinctness level of values across the given columns (result of 1 means every value is distinct)

    Checks the distinctness level of values across the given columns (result of 1 means every value is distinct)

    threshold

    - the threshold for what number of distinct values is acceptable

    onColumns

    - the columns to check for distinct values in

    filter

    - the filter that is applied before the distinct value count is done

  9. def doubleMaxValueCheck(threshold: AbsoluteThreshold[Double], onColumn: String, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[OptDoubleMetric]

    Permalink

    Checks the max value of a given Double column in a dataset after the given filter is applied is within the given threshold

    Checks the max value of a given Double column in a dataset after the given filter is applied is within the given threshold

    threshold

    the threshold for what fraction of rows is acceptable

    onColumn

    column on which max value needs to be computed

    filter

    the filter that is applied before the dataset max value is computed

  10. def doubleMinValueCheck(threshold: AbsoluteThreshold[Double], onColumn: String, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[OptDoubleMetric]

    Permalink

    Checks the min value of a given Double column in a dataset after the given filter is applied is within the given threshold

    Checks the min value of a given Double column in a dataset after the given filter is applied is within the given threshold

    threshold

    the threshold for what fraction of rows is acceptable

    onColumn

    column on which min value needs to be computed

    filter

    the filter that is applied before the dataset min value is computed

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def longMaxValueCheck(threshold: AbsoluteThreshold[Long], onColumn: String, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[OptLongMetric]

    Permalink

    Checks the max value of a given Int or Long column in a dataset after the given filter is applied is within the given threshold

    Checks the max value of a given Int or Long column in a dataset after the given filter is applied is within the given threshold

    threshold

    the threshold for what fraction of rows is acceptable

    onColumn

    column on which max value needs to be computed

    filter

    the filter that is applied before the dataset max value is computed

  18. def longMinValueCheck(threshold: AbsoluteThreshold[Long], onColumn: String, filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[OptLongMetric]

    Permalink

    Checks the min value of a given Int or Long column in a dataset after the given filter is applied is within the given threshold

    Checks the min value of a given Int or Long column in a dataset after the given filter is applied is within the given threshold

    threshold

    the threshold for what fraction of rows is acceptable

    onColumn

    column on which min value needs to be computed

    filter

    the filter that is applied before the dataset min value is computed

  19. def maxValueCheck[MV <: OptNumericMetricValue](threshold: AbsoluteThreshold[SingleMetricCheck.maxValueCheck.MV.U], onColumn: String, filter: MetricFilter = MetricFilter.noFilter)(implicit arg0: MetricValueConstructor[MV]): SingleMetricCheck[MV]

    Permalink

    Checks the max value of a given column in a dataset after the given filter is applied is within the given threshold

    Checks the max value of a given column in a dataset after the given filter is applied is within the given threshold

    MV

    - type of optional metric value that will be used (should match the column type you're calculating the metric on)

    threshold

    the threshold for what fraction of rows is acceptable

    onColumn

    column on which min value needs to be computed

    filter

    the filter that is applied before the dataset min value is computed

  20. def minValueCheck[MV <: OptNumericMetricValue](threshold: AbsoluteThreshold[SingleMetricCheck.minValueCheck.MV.U], onColumn: String, filter: MetricFilter = MetricFilter.noFilter)(implicit arg0: MetricValueConstructor[MV]): SingleMetricCheck[MV]

    Permalink

    Checks the min value of a given column in a dataset after the given filter is applied is within the given threshold

    Checks the min value of a given column in a dataset after the given filter is applied is within the given threshold

    MV

    - type of optional metric value that will be used (should match the column type you're calculating the metric on)

    threshold

    the threshold for what fraction of rows is acceptable

    onColumn

    column on which min value needs to be computed

    filter

    the filter that is applied before the dataset min value is computed

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. def optThresholdBasedCheck[MV <: OptNumericMetricValue](metricDescriptor: MetricDescriptor { type MetricType = MV }, description: String, threshold: AbsoluteThreshold[SingleMetricCheck.optThresholdBasedCheck.MV.U]): SingleMetricCheck[MV]

    Permalink

    A check based on a single optional metric that checks if that metric is within the given threshold.

    A check based on a single optional metric that checks if that metric is within the given threshold. If the metric has a value of None the check will automatically fail

    MV

    - the type of the MetricValue that will be calculated in order to complete this check

    metricDescriptor

    - describes the metric the check will be done on

    description

    - the user friendly description for this check

    threshold

    - the threshold that the metric must be within to pass

  25. def sizeCheck(threshold: AbsoluteThreshold[Long], filter: MetricFilter = MetricFilter.noFilter): SingleMetricCheck[LongMetric]

    Permalink

    Checks the count of rows in a dataset after the given filter is applied is within the given threshold

    Checks the count of rows in a dataset after the given filter is applied is within the given threshold

    filter

    - filter to be applied before rows are counted

  26. def sumValueCheck[MV <: NumericMetricValue](threshold: AbsoluteThreshold[SingleMetricCheck.sumValueCheck.MV.T], onColumn: String, filter: MetricFilter = MetricFilter.noFilter)(implicit arg0: MetricValueConstructor[MV]): SingleMetricCheck[MV]

    Permalink

    Checks the sum of value of rows in a dataset for a given col after the given filter is applied is within the given threshold

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def thresholdBasedCheck[MV <: MetricValue](metricDescriptor: MetricDescriptor { type MetricType = MV }, description: String, threshold: AbsoluteThreshold[SingleMetricCheck.thresholdBasedCheck.MV.T]): SingleMetricCheck[MV]

    Permalink

    A check based on a single metric that checks if that metric is within the given threshold

    A check based on a single metric that checks if that metric is within the given threshold

    MV

    - the type of the MetricValue that will be calculated in order to complete this check

    metricDescriptor

    - describes the metric the check will be done on

    description

    - the user friendly description for this check

    threshold

    - the threshold that the metric must be within to pass

  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped