Package com.streambase.sb.unittest

Class FieldBasedTupleComparator

java.lang.Object

com.streambase.sb.unittest.FieldBasedTupleComparator

All Implemented Interfaces:

TupleComparator

public class FieldBasedTupleComparator
extends Object
implements TupleComparator

A TupleComparator that compares tuples in a naive field-by-field manner. Comparison of individual field types can be controlled using FieldBasedTupleComparator.CompareFunctors. A subset of the fields for a tuple can by explicitly specifying the field names.

DEFAULT_COMPARATOR provides a reasonable default comparison of tuples.

DEFAULT_COMPARE_REGISTRY provides a filled in registry of default FieldBasedTupleComparator.CompareFunctors.

Since:

6.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldBasedTupleComparator.CompareFunctor	A strategy object for handling comparisons of specific field types.
static class	FieldBasedTupleComparator.DoubleCompareFunctor	Compare double values using a ratio test and a tolerance.
static class	FieldBasedTupleComparator.IgnoreTimestampCompareFunctor	Ignore timestamp compare functor
static class	FieldBasedTupleComparator.ListCompareFunctor	List compare functor
static class	FieldBasedTupleComparator.NaiveObjectCompareFunctor	Simple object compare functor
static class	FieldBasedTupleComparator.RegexCompareFunctor	Check if the second argument matches the regex defined for the first argument.
static class	FieldBasedTupleComparator.TupleCompareFunctor	Tuple compare functor

Field Summary

Fields

Modifier and Type	Field	Description
static final FieldBasedTupleComparator	DEFAULT_COMPARATOR	Default comparator
static final com.streambase.sb.DataType.Registry<FieldBasedTupleComparator.CompareFunctor>	DEFAULT_COMPARE_REGISTRY	Default compare functor registry
static final Map<DataType,FieldBasedTupleComparator.CompareFunctor>	DEFAULT_FUNCTOR_MAP	Default functor data type to functor map
static final FieldBasedTupleComparator	IGNORE_TIMESTAMP_COMPARATOR	Ignore timestamp comparator
static final FieldBasedTupleComparator	REGEX_COMPARATOR	Regular expression comparator

Constructor Summary

Constructors

Constructor	Description
FieldBasedTupleComparator(com.streambase.sb.DataType.Registry<FieldBasedTupleComparator.CompareFunctor> comparators, String... fields)	Constructor
FieldBasedTupleComparator(FieldBasedTupleComparator baseComparator, String... fields)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	compare(Tuple expected, Tuple actual)	Compare two tuples.
boolean	compareValues(CompleteDataType cdt, Object expected, Object actual)	Compare two values with CompleteDataType cdt.
String	formatForErrorMessage(Tuple t)	Convert the provided Tuple into a string appropriate for error messages.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_FUNCTOR_MAP

public static final Map<DataType,FieldBasedTupleComparator.CompareFunctor> DEFAULT_FUNCTOR_MAP

Default functor data type to functor map

DEFAULT_COMPARE_REGISTRY

public static final com.streambase.sb.DataType.Registry<FieldBasedTupleComparator.CompareFunctor> DEFAULT_COMPARE_REGISTRY

Default compare functor registry

DEFAULT_COMPARATOR

public static final FieldBasedTupleComparator DEFAULT_COMPARATOR

Default comparator

REGEX_COMPARATOR

public static final FieldBasedTupleComparator REGEX_COMPARATOR

Regular expression comparator

IGNORE_TIMESTAMP_COMPARATOR

public static final FieldBasedTupleComparator IGNORE_TIMESTAMP_COMPARATOR

Ignore timestamp comparator

Constructor Details

FieldBasedTupleComparator

public FieldBasedTupleComparator(com.streambase.sb.DataType.Registry<FieldBasedTupleComparator.CompareFunctor> comparators,
 String... fields)
                          throws StreamBaseException

Constructor

Parameters:

comparators - comparators

fields - fields to compare

Throws:

StreamBaseException - initialization error

FieldBasedTupleComparator

public FieldBasedTupleComparator(FieldBasedTupleComparator baseComparator,
 String... fields)
                          throws StreamBaseException

Constructor

Parameters:

baseComparator - base comparator

fields - fields to compare

Throws:

StreamBaseException - initialization error

Method Details

compare

public boolean compare(Tuple expected,
 Tuple actual)
                throws StreamBaseException

Description copied from interface: TupleComparator

Compare two tuples.

Specified by:

compare in interface TupleComparator

Parameters:

expected - The expected value

actual - The actual value

Returns:

true if the tuples are equal

Throws:

StreamBaseException - error comparing tuples

compareValues

public boolean compareValues(CompleteDataType cdt,
 Object expected,
 Object actual)
                      throws StreamBaseException

Description copied from interface: TupleComparator

Compare two values with CompleteDataType cdt.

Specified by:

compareValues in interface TupleComparator

Parameters:

cdt - The CompleteDataType for the objects being compared

expected - The expected value

actual - The actual value

Returns:

true if the values are equal

Throws:

StreamBaseException - error comparing tuples

formatForErrorMessage

public String formatForErrorMessage(Tuple t)

Description copied from interface: TupleComparator

Convert the provided Tuple into a string appropriate for error messages. Some comparators may wish to omit fields that are not salient to the comparison.

Specified by:

formatForErrorMessage in interface TupleComparator

Parameters:

t - The tuple to format

Returns:

A human readable string.