com.github.timgent.sparkdataquality.metrics.MetricDescriptor

ComplianceMetric

case class ComplianceMetric(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

Alphabetic
By Inheritance

Inherited

ComplianceMetric
Serializable
Serializable
Product
Equals
Filterable
MetricDescriptor
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new ComplianceMetric(complianceFn: ComplianceFn, filter: MetricFilter = MetricFilter.noFilter)
complianceFn
- the criteria used to check each rows compliance
filter
- a filter to be applied before the compliance fraction is calculated

Type Members

type MC = ComplianceMetricCalculator

Definition Classes
ComplianceMetric → MetricDescriptor
type MetricType = MetricCalculator.ComplianceMetricCalculator.MetricType

Definition Classes
MetricDescriptor

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
val complianceFn: ComplianceFn
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val filter: MetricFilter
A filter to apply before calculation of the metric
A filter to apply before calculation of the metric
returns
the MetricFilter

Definition Classes
ComplianceMetric → Filterable
def finalize(): Unit

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

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def metricCalculator: ComplianceMetricCalculator
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
ComplianceMetric → MetricDescriptor
def metricName: String
A name for the metric
A name for the metric

Definition Classes
ComplianceMetric → MetricDescriptor
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toSimpleMetricDescriptor: SimpleMetricDescriptor
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
ComplianceMetric → MetricDescriptor
final def wait(): Unit

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

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

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

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
Annotations
@native()
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

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

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0

Definition Classes
Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any

Ungrouped

type MC = ComplianceMetricCalculator

Definition Classes
ComplianceMetric → MetricDescriptor
type MetricType = MetricCalculator.ComplianceMetricCalculator.MetricType

Definition Classes
MetricDescriptor

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
val complianceFn: ComplianceFn
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val filter: MetricFilter
A filter to apply before calculation of the metric
A filter to apply before calculation of the metric
returns
the MetricFilter

Definition Classes
ComplianceMetric → Filterable
def finalize(): Unit

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

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def metricCalculator: ComplianceMetricCalculator
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
ComplianceMetric → MetricDescriptor
def metricName: String
A name for the metric
A name for the metric

Definition Classes
ComplianceMetric → MetricDescriptor
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toSimpleMetricDescriptor: SimpleMetricDescriptor
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
ComplianceMetric → MetricDescriptor
final def wait(): Unit

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

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

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

Packages

ComplianceMetric 

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

Instance Constructors

Type Members

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

ComplianceMetric