Class

com.github.timgent.dataflare.checks.metrics

DualMetricCheck

Related Doc: package metrics

Permalink

final case class DualMetricCheck[MV <: MetricValue](dsMetric: MetricDescriptor { type MetricType = MV }, dsToCompareMetric: MetricDescriptor { type MetricType = MV }, checkDescription: String, metricComparator: MetricComparator[MV]) extends MetricsBasedCheck with DualDsQCCheck with Product with Serializable

A check based on a metric for one dataset compared to a metric on another dataset

dsMetric

- the metric to be used on dataset a

dsToCompareMetric

- the metric to be used on dataset b

checkDescription

- description of the check

metricComparator

- comparison function for the metrics which determines if the check passes

Linear Supertypes
Serializable, Serializable, Product, Equals, DualDsQCCheck, MetricsBasedCheck, QCCheck, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DualMetricCheck
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DualDsQCCheck
  7. MetricsBasedCheck
  8. QCCheck
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DualMetricCheck(dsMetric: MetricDescriptor { type MetricType = MV }, dsToCompareMetric: MetricDescriptor { type MetricType = MV }, checkDescription: String, metricComparator: MetricComparator[MV])

    Permalink

    dsMetric

    - the metric to be used on dataset a

    dsToCompareMetric

    - the metric to be used on dataset b

    checkDescription

    - description of the check

    metricComparator

    - comparison function for the metrics which determines if the check passes

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. def applyCheckOnMetrics(dsAMetrics: Map[MetricDescriptor, MetricValue], dsBMetrics: Map[MetricDescriptor, MetricValue], dualDsDescription: DualDsDescription)(implicit classTag: ClassTag[MV]): CheckResult

    Permalink

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. val checkDescription: String

    Permalink

    - description of the check

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def description: CheckDescription

    Permalink
    Definition Classes
    DualMetricCheck → QCCheck

  9. val dsMetric: MetricDescriptor { type MetricType = MV }

    Permalink

    - the metric to be used on dataset a

  10. val dsToCompareMetric: MetricDescriptor { type MetricType = MV }

    Permalink

    - the metric to be used on dataset b

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

    Permalink
    Definition Classes
    AnyRef

  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. val metricComparator: MetricComparator[MV]

    Permalink

    - comparison function for the metrics which determines if the check passes

  16. final def metricNotPresentErrorResult: CheckResult

    Permalink
    Attributes
    protected
    Definition Classes
    MetricsBasedCheck

  17. final def metricTypeErrorResult: CheckResult

    Permalink
    Attributes
    protected
    Definition Classes
    MetricsBasedCheck

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

    Permalink
    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. def qcType: QcType

    Permalink
    Definition Classes
    DualMetricCheck → MetricsBasedCheck → QCCheck

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

    Permalink
    Definition Classes
    AnyRef

  23. final def wait(): Unit

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

  24. final def wait(arg0: Long, arg1: Int): Unit

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

  25. final def wait(arg0: Long): Unit

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DualDsQCCheck

Inherited from MetricsBasedCheck

Inherited from QCCheck

Inherited from AnyRef

Inherited from Any

Ungrouped