com.bfm.topnotch.tnassertion

TnAssertionRunner

class TnAssertionRunner extends AnyRef

The class for running assertions against a dataset and generating reports.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TnAssertionRunner
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TnAssertionRunner(persister: TnPersister)

    persister

    The object to use to persist reports to a location where a UI can read them.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def checkAssertion(assertion: TnAssertionParams, df: DataFrame, totalCount: Long): TnAssertionReport

    Check whether an assertion matches a dataset and generate a report for the assertion

    Check whether an assertion matches a dataset and generate a report for the assertion

    assertion

    The assertion to check against the data set

    df

    The data set, stored as a dataframe, to scan

    totalCount

    The number of rows in df, precomputed as this function will be called many times

    returns

    The report summarizing the results of running the assertion.

    Attributes
    protected[com.bfm.topnotch.tnassertion]
  8. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. def identifyInvalidRows(input: DataFrame, assertions: Seq[TnAssertionParams]): DataFrame

    Produce a data set with a single field for each invalid row containing all the reasons it is invalid.

    Produce a data set with a single field for each invalid row containing all the reasons it is invalid.

    input

    the entire data set, invalid and valid rows

    assertions

    the assertions to check

    returns

    A dataframe containing every invalid row. It contains the row's data and the descriptions of all the assertions claiming it is invalid.

    Attributes
    protected[com.bfm.topnotch.tnassertion]
  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  19. def runAssertions(input: DataFrame, reportKey: String, assertions: Seq[TnAssertionParams]): DataFrame

    Run a set of assertions on a data set, write a report summarizing the results to a persistent location, and return a data set containing all the invalid rows and the reasons why the rows are invalid

    Run a set of assertions on a data set, write a report summarizing the results to a persistent location, and return a data set containing all the invalid rows and the reasons why the rows are invalid

    input

    The input data to run the assertions on

    reportKey

    The key used to refer to the report when loading it from the UI

    assertions

    The rules to run against the dataset

    returns

    A data set containing every row declared invalid by at least one assertion and the reasons why each row is invalid

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

    Definition Classes
    AnyRef
  21. def toString(): String

    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped