org.dbunit.assertion.comparer.value

Class ValueComparerTemplateBase

java.lang.Object

org.dbunit.assertion.comparer.value.ValueComparerBase

org.dbunit.assertion.comparer.value.ValueComparerTemplateBase

All Implemented Interfaces:

ValueComparer

Direct Known Subclasses:

IsActualEqualToExpectedValueComparer, IsActualEqualToExpectedWithEmptyFailMessageValueComparer, IsActualGreaterThanExpectedValueComparer, IsActualGreaterThanOrEqualToExpectedValueComparer, IsActualLessThanExpectedValueComparer, IsActualLessThanOrEqualToExpectedValueComparer, IsActualNotEqualToExpectedValueComparer, IsActualWithinToleranceOfExpectedTimestampValueComparer, NeverFailsValueComparer

public abstract class ValueComparerTemplateBase
extends ValueComparerBase

Base class for ValueComparers, providing template methods and common elements.

Since:

2.6.0

Author:

Jeff Jensen

Field Summary

Fields inherited from class org.dbunit.assertion.comparer.value.ValueComparerBase

BASE_FAIL_MSG

Constructor Summary

Constructors

Constructor and Description
ValueComparerTemplateBase()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	doCompare(ITable expectedTable, ITable actualTable, int rowNum, java.lang.String columnName, DataType dataType, java.lang.Object expectedValue, java.lang.Object actualValue) Do the comparison and return a fail message or null if comparison passes.
protected abstract java.lang.String	getFailPhrase()
protected abstract boolean	isExpected(ITable expectedTable, ITable actualTable, int rowNum, java.lang.String columnName, DataType dataType, java.lang.Object expectedValue, java.lang.Object actualValue)
protected java.lang.String	makeFailMessage(java.lang.Object expectedValue, java.lang.Object actualValue) Makes the fail message using getFailPhrase().

Methods inherited from class org.dbunit.assertion.comparer.value.ValueComparerBase

compare, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ValueComparerTemplateBase

public ValueComparerTemplateBase()

Method Detail

doCompare

protected java.lang.String doCompare(ITable expectedTable,
                                     ITable actualTable,
                                     int rowNum,
                                     java.lang.String columnName,
                                     DataType dataType,
                                     java.lang.Object expectedValue,
                                     java.lang.Object actualValue)
                              throws DatabaseUnitException

Do the comparison and return a fail message or null if comparison passes. This implementation calls isExpected(ITable, ITable, int, String, DataType, Object, Object).

Specified by:

doCompare in class ValueComparerBase

Throws:

DatabaseUnitException

See Also:

ValueComparer.compare(ITable, ITable, int, String, DataType, Object, Object)

makeFailMessage

protected java.lang.String makeFailMessage(java.lang.Object expectedValue,
                                           java.lang.Object actualValue)

Makes the fail message using getFailPhrase().

Returns:

the formatted fail message with the fail phrase.

isExpected

protected abstract boolean isExpected(ITable expectedTable,
                                      ITable actualTable,
                                      int rowNum,
                                      java.lang.String columnName,
                                      DataType dataType,
                                      java.lang.Object expectedValue,
                                      java.lang.Object actualValue)
                               throws DatabaseUnitException

Returns:

true if comparing actual to expected is as expected.

Throws:

DatabaseUnitException

getFailPhrase

protected abstract java.lang.String getFailPhrase()

Returns:

The text snippet for substitution in ValueComparerBase.BASE_FAIL_MSG.