org.apache.drill.test.rowSet

Class RowSetComparison

java.lang.Object

org.apache.drill.test.rowSet.RowSetComparison

public class RowSetComparison
extends Object

For testing, compare the contents of two row sets (record batches) to verify that they are identical. Supports masks to exclude certain columns from comparison.

Drill rows are analogous to JSON documents: they can have scalars, arrays and maps, with maps and lists holding maps, arrays and scalars. This class walks the row structure tree to compare each structure of two row sets checking counts, types and values to ensure that the "actual" result set (result of a test) matches the "expected" result set.

This class acts as an example of how to use the suite of reader abstractions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RowSetComparison.ObjectComparator

Constructor Summary

Constructors

Constructor and Description
RowSetComparison(RowSet expected)

Method Summary

Modifier and Type	Method and Description
RowSetComparison	exclude(int colNo) Mark a specific column as excluded from comparisons.
RowSetComparison	offset(int offset) Specify an offset into the row sets to start the comparison.
RowSetComparison	span(int span) Specify a subset of rows to compare.
void	unorderedVerify(RowSet actual)
void	unorderedVerifyAndClearAll(RowSet actual) Verifies the actual results, then frees memory for both the expected and actual result sets.
void	verify(RowSet actual) Verify the actual rows using the rules defined in this builder
void	verifyAndClear(RowSet actual) Convenience method to verify the actual results, then free memory for the actual result sets.
void	verifyAndClearAll(RowSet actual) Convenience method to verify the actual results, then free memory for both the expected and actual result sets.
RowSetComparison	withMask(Boolean... flags) Specifies a "selection" mask that determines which columns to compare.
RowSetComparison	withScale(int scale) Specify the precision to use when comparing float or double values.

Methods inherited from class java.lang.Object

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

Constructor Detail

RowSetComparison

public RowSetComparison(RowSet expected)

Method Detail

exclude

public RowSetComparison exclude(int colNo)

Mark a specific column as excluded from comparisons.

Parameters:

colNo - the index of the column to exclude

Returns:

this builder

withMask

public RowSetComparison withMask(Boolean... flags)

Specifies a "selection" mask that determines which columns to compare. Columns marked as "false" are omitted from the comparison.

Parameters:

flags - variable-length list of column flags

Returns:

this builder

withScale

public RowSetComparison withScale(int scale)

Specify the precision to use when comparing float or double values.

Parameters:

scale - the precision to use for comparing floats and doubles. See BigDecimal.scale() for a definition scale.

Returns:

this builder

offset

public RowSetComparison offset(int offset)

Specify an offset into the row sets to start the comparison. Usually combined with span(int).

Parameters:

offset - offset into the row set to start the comparison

Returns:

this builder

span

public RowSetComparison span(int span)

Specify a subset of rows to compare. Usually combined with offset(int).

Parameters:

span - the number of rows to compare

Returns:

this builder

unorderedVerify

public void unorderedVerify(RowSet actual)

unorderedVerifyAndClearAll

public void unorderedVerifyAndClearAll(RowSet actual)

Verifies the actual results, then frees memory for both the expected and actual result sets.

Parameters:

actual - the actual results to verify

verify

public void verify(RowSet actual)

Verify the actual rows using the rules defined in this builder

Parameters:

actual - the actual results to verify

verifyAndClear

public void verifyAndClear(RowSet actual)

Convenience method to verify the actual results, then free memory for the actual result sets.

Parameters:

actual - the actual results to verify

verifyAndClearAll

public void verifyAndClearAll(RowSet actual)

Convenience method to verify the actual results, then free memory for both the expected and actual result sets.

Parameters:

actual - the actual results to verify