Package com.illumon.iris.validation.logger

Interface DataQualityTestLogger

All Known Implementing Classes:

SimpleDataQualityTestLogger

public interface DataQualityTestLogger

An interface for logging the results of data quality tests.

Method Summary

Modifier and Type	Method	Description
void	fail(TableValidationSuite suite, String method, String exception, long executionTimeMillis)	The test failed.
void	finished()	All tests are finished.
default String	getFirstExceptionString()	Optional implementation - get the first logged failure exception String
int	getNFailures()	Gets the number of test failures.
int	getNPasses()	Gets the number of test passes.
int	getNSkips()	Gets the number of test skips.
void	message(TableValidationSuite suite, String method, String message)	Record a message.
void	pass(TableValidationSuite suite, String method, long executionTimeMillis)	The test passed.
void	skip(TableValidationSuite suite, String method)	The test was skipped.

Method Details

pass

void pass(TableValidationSuite suite, String method, long executionTimeMillis)

The test passed.

Parameters:

suite - configuration being tested.

method - method being tested.

executionTimeMillis - time the test took to execute.

fail

void fail(TableValidationSuite suite, String method, String exception, long executionTimeMillis)

The test failed.

Parameters:

suite - configuration being tested.

method - method being tested.

exception - exception leading to the failure.

executionTimeMillis - time the test took to execute.

skip

void skip(TableValidationSuite suite, String method)

The test was skipped.

Parameters:

suite - configuration being tested.

method - method being tested.

message

void message(TableValidationSuite suite, String method, String message)

Record a message.

Parameters:

suite - configuration being tested.

method - method being tested.

message - message to record

finished

void finished()

All tests are finished.

getNFailures

int getNFailures()

Gets the number of test failures.

Returns:

number of test failures.

getNPasses

int getNPasses()

Gets the number of test passes.

Returns:

number of test passes.

getNSkips

int getNSkips()

Gets the number of test skips.

Returns:

number of test skips.

getFirstExceptionString

default String getFirstExceptionString()

Optional implementation - get the first logged failure exception String

Returns:

a String representing the first test failure, or null