Class

com.github.timgent.sparkdataquality.checks.metrics.SingleMetricBasedCheck

ComplianceCheck

Related Doc: package SingleMetricBasedCheck

Permalink

case class ComplianceCheck(threshold: AbsoluteThreshold[Double], complianceFn: ComplianceFn, filter: MetricFilter = MetricFilter.noFilter) extends ThresholdBasedCheck[DoubleMetric] with Product with Serializable

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

Linear Supertypes
Serializable, Serializable, Product, Equals, ThresholdBasedCheck[DoubleMetric], SingleMetricBasedCheck[DoubleMetric], MetricsBasedCheck, QCCheck, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ComplianceCheck
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ThresholdBasedCheck
  7. SingleMetricBasedCheck
  8. MetricsBasedCheck
  9. QCCheck
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ComplianceCheck(threshold: AbsoluteThreshold[Double], complianceFn: ComplianceFn, filter: MetricFilter = MetricFilter.noFilter)

    Permalink

    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

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 applyCheck(metric: DoubleMetric): CheckResult

    Permalink
    Attributes
    protected
    Definition Classes
    ThresholdBasedCheck → SingleMetricBasedCheck

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def checkShortName: String

    Permalink
    Definition Classes
    ComplianceCheck → ThresholdBasedCheck

  7. def clone(): AnyRef

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

  8. val complianceFn: ComplianceFn

    Permalink

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

  9. def description: String

    Permalink
    Definition Classes
    ComplianceCheck → QCCheck

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

    Permalink
    Definition Classes
    AnyRef

  11. val filter: MetricFilter

    Permalink

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

  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. def metricDescriptor: MetricDescriptor

    Permalink
    Definition Classes
    ComplianceCheck → SingleMetricBasedCheck

  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
    MetricsBasedCheck → QCCheck

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

    Permalink
    Definition Classes
    AnyRef

  23. val threshold: AbsoluteThreshold[Double]

    Permalink

    - the threshold for what fraction of rows is acceptable

    - the threshold for what fraction of rows is acceptable

    Definition Classes
    ComplianceCheck → ThresholdBasedCheck

  24. final def wait(): Unit

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

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

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

  26. 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 ThresholdBasedCheck[DoubleMetric]

Inherited from SingleMetricBasedCheck[DoubleMetric]

Inherited from MetricsBasedCheck

Inherited from QCCheck

Inherited from AnyRef

Inherited from Any

Ungrouped