Class

com.github.timgent.sparkdataquality.metrics.MetricDescriptor

ComplianceMetricDescriptor

Related Doc: package MetricDescriptor

Permalink

case class ComplianceMetricDescriptor(complianceFn: ComplianceFn, filter: MetricFilter = MetricFilter.noFilter) extends MetricDescriptor with Filterable with Product with Serializable

A metric that calculates what fraction of rows comply with the given criteria

complianceFn

- the criteria used to check each rows compliance

filter

- a filter to be applied before the compliance fraction is calculated

Linear Supertypes
Serializable, Serializable, Product, Equals, Filterable, MetricDescriptor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ComplianceMetricDescriptor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Filterable
  7. MetricDescriptor
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ComplianceMetricDescriptor(complianceFn: ComplianceFn, filter: MetricFilter = MetricFilter.noFilter)

    Permalink

    complianceFn

    - the criteria used to check each rows compliance

    filter

    - a filter to be applied before the compliance fraction is calculated

Type Members

  1. type MC = ComplianceMetricCalculator

    Permalink
    Definition Classes
    ComplianceMetricDescriptor → MetricDescriptor

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. val complianceFn: ComplianceFn

    Permalink

    - the criteria used to check each rows compliance

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

    Permalink
    Definition Classes
    AnyRef

  8. val filter: MetricFilter

    Permalink

    - a filter to be applied before the compliance fraction is calculated

    - a filter to be applied before the compliance fraction is calculated

    Definition Classes
    ComplianceMetricDescriptor → Filterable

  9. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. def metricCalculator: ComplianceMetricCalculator

    Permalink

    The metricCalculator which contains key logic for calculating a MetricValue for this MetricDescriptor

    The metricCalculator which contains key logic for calculating a MetricValue for this MetricDescriptor

    returns

    the MetricCalculator

    Definition Classes
    ComplianceMetricDescriptor → MetricDescriptor

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  17. def toSimpleMetricDescriptor: SimpleMetricDescriptor

    Permalink

    A representation of the MetricDescriptor that can be more easily handled for persistence

    A representation of the MetricDescriptor that can be more easily handled for persistence

    returns

    the SimpleMetricDescriptor

    Definition Classes
    ComplianceMetricDescriptor → MetricDescriptor

  18. final def wait(): Unit

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

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

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

  20. 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 Filterable

Inherited from MetricDescriptor

Inherited from AnyRef

Inherited from Any

Ungrouped