Packages

c

org.checkita.dqf.core.checks.snapshot

GreaterThanCheckCalculator

case class GreaterThanCheckCalculator(checkId: String, baseMetric: String, compareMetric: Option[String], compareThreshold: Option[Double]) extends CompareCheckCalculator with Product with Serializable

Greater than check calculator: verifies that base metric result is greater than either a given threshold or a provided compare metric result.

checkId

Check ID

baseMetric

Base metric to check

compareMetric

Metric to compare with

compareThreshold

Threshold to compare with

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

Instance Constructors

  1. new GreaterThanCheckCalculator(checkId: String, baseMetric: String, compareMetric: Option[String], compareThreshold: Option[Double])

    checkId

    Check ID

    baseMetric

    Base metric to check

    compareMetric

    Metric to compare with

    compareThreshold

    Threshold to compare with

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val baseMetric: String
    Definition Classes
    GreaterThanCheckCalculator → CheckCalculator
  6. val checkId: String
    Definition Classes
    GreaterThanCheckCalculator → CheckCalculator
  7. val checkName: CheckName
    Definition Classes
    GreaterThanCheckCalculator → CheckCalculator
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. val compareFunc: (Double, Double) ⇒ Boolean
    Attributes
    protected
    Definition Classes
    GreaterThanCheckCalculator → CompareCheckCalculator
  10. val compareFuncFailureRepr: (Double, Double) ⇒ String
    Attributes
    protected
    Definition Classes
    GreaterThanCheckCalculator → CompareCheckCalculator
  11. val compareFuncString: String
    Attributes
    protected
    Definition Classes
    GreaterThanCheckCalculator → CompareCheckCalculator
  12. val compareFuncSuccessRepr: (Double, Double) ⇒ String
    Attributes
    protected
    Definition Classes
    GreaterThanCheckCalculator → CompareCheckCalculator
  13. val compareMetric: Option[String]
    Definition Classes
    GreaterThanCheckCalculator → CheckCalculator
  14. val compareResOption: (Option[MetricCalculatorResult], Option[Double]) ⇒ Option[Double]
    Attributes
    protected
    Definition Classes
    CompareCheckCalculator
  15. val compareThreshold: Option[Double]
    Definition Classes
    GreaterThanCheckCalculator → CompareCheckCalculator
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def errorMsg(e: Throwable): String

    Generates error message provided with caught error.

    Generates error message provided with caught error.

    e

    Error that has been caught

    returns

    Error message

    Attributes
    protected
    Definition Classes
    CheckCalculator
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getDetailsMsg(compareMetricResult: Option[MetricCalculatorResult]): Option[String]

    Gets check details message to insert into final check message.

    Gets check details message to insert into final check message.

    compareMetricResult

    Compare metric result

    returns

    Check details message

    Attributes
    protected
    Definition Classes
    CompareCheckCalculator → CheckCalculator
  21. def getMessage(baseMetricResult: MetricCalculatorResult, compareMetricResult: Option[MetricCalculatorResult], status: CalculatorStatus, statusString: String): String

    Generates comprehensive check message

    Generates comprehensive check message

    baseMetricResult

    Base metric result

    compareMetricResult

    Compare metric result

    status

    Check evaluation status

    statusString

    Check evaluation status string

    returns

    Check message

    Attributes
    protected
    Definition Classes
    CheckCalculator
  22. def getOptionHead(resSeq: Option[Seq[MetricCalculatorResult]]): Option[MetricCalculatorResult]

    Safely gets head out of optional sequence of metric calculator results.

    Safely gets head out of optional sequence of metric calculator results.

    resSeq

    Optional sequence of metric calculator results

    returns

    Optional metric calculator result

    Attributes
    protected
    Definition Classes
    CheckCalculator
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val lBound: (Option[MetricCalculatorResult], Option[Double]) ⇒ Option[Double]
    Attributes
    protected
    Definition Classes
    GreaterThanCheckCalculator → CompareCheckCalculator
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. val noneBound: (Option[MetricCalculatorResult], Option[Double]) ⇒ Option[Double]
    Attributes
    protected
    Definition Classes
    CompareCheckCalculator
  27. val notFoundErrMsg: String
    Attributes
    protected
    Definition Classes
    CheckCalculator
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def resultOnError(err: Throwable, baseMetricResults: Seq[MetricCalculatorResult], compareMetricResults: Option[Seq[MetricCalculatorResult]]): CheckCalculatorResult

    Callback method that process possible runtime error that can be thrown during check evaluation.

    Callback method that process possible runtime error that can be thrown during check evaluation.

    err

    Error thrown during check evaluation

    baseMetricResults

    Sequence of base metric result for metric ID referenced by this check

    compareMetricResults

    Sequence of compare metric result for compareMetric ID referenced by this check

    returns

    Check result with Error status and captured error message

    Attributes
    protected
    Definition Classes
    CompareCheckCalculator → CheckCalculator
    Note

    TopN metric yields multiple results

  31. def resultOnMetricNotFound: CheckCalculatorResult

    Callback method that is used when metric results are not found for metric ID referenced in this check

    Callback method that is used when metric results are not found for metric ID referenced in this check

    returns

    Check result with Error status and 'not found' error message

    Attributes
    protected
    Definition Classes
    CompareCheckCalculator → CheckCalculator
  32. def run(metricResults: MetricResults)(implicit jobId: String, manager: Option[DqStorageManager], settings: AppSettings, spark: SparkSession, fs: FileSystem): CheckCalculatorResult

    Safely runs check provided with all the metric calculators results.

    Safely runs check provided with all the metric calculators results. There are three scenarios covered:

    • Check evaluates normally and returns either Success or Failure status (depending on whether check condition was met)
    • Check evaluation throws runtime error: check result with Error status and corresponding error message is returned.
    • Metric results are not found for metric ID defined in the check: check cannot be run at all and check result with Error status and corresponding message is returned.
    metricResults

    All computed metrics

    jobId

    Current Job ID

    manager

    Implicit storage manager used to load historical results

    settings

    Implicit application settings

    spark

    Implicit spark session object

    fs

    Implicit hadoop filesystem object

    returns

    Check result

    Definition Classes
    CheckCalculator
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def tryToRun(baseMetricResults: Seq[MetricCalculatorResult], compareMetricResults: Option[Seq[MetricCalculatorResult]])(implicit jobId: String, manager: Option[DqStorageManager], settings: AppSettings, spark: SparkSession, fs: FileSystem): CheckCalculatorResult

    Runs the check for the given metric results.

    Runs the check for the given metric results.

    baseMetricResults

    Sequence of base metric result for metric ID referenced by this check

    compareMetricResults

    Sequence of compare metric result for compareMetric ID referenced by this check

    jobId

    Current Job ID

    manager

    Implicit storage manager used to load historical results

    settings

    Implicit application settings

    spark

    Implicit spark session object

    fs

    Implicit hadoop filesystem object

    returns

    Check evaluation result with either Success or Failure status

    Attributes
    protected
    Definition Classes
    CompareCheckCalculator → CheckCalculator
    Note

    TopN metric yields multiple results

  35. val uBound: (Option[MetricCalculatorResult], Option[Double]) ⇒ Option[Double]
    Attributes
    protected
    Definition Classes
    GreaterThanCheckCalculator → CompareCheckCalculator
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  39. val windowString: Option[String]
    Attributes
    protected
    Definition Classes
    CompareCheckCalculator → CheckCalculator

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CompareCheckCalculator

Inherited from CheckCalculator

Inherited from AnyRef

Inherited from Any

Ungrouped