eu.stratosphere.core.testing

Class GenericTestRecords<T>

java.lang.Object

eu.stratosphere.core.testing.GenericTestRecords<T>

Type Parameters:

T - the record type

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>

Direct Known Subclasses:

TestRecords

public class GenericTestRecords<T>
extends Object
implements Closeable, Iterable<T>

Base class for representing the input or output values of a GenericTestPlan. The class is especially important when setting the expected values in the GenericTestPlan.

There are two ways to specify the values:

1. From a file: with load(Class, Configuration) and load(Class, String, Configuration) the location, format, and configuration of the data can be specified. The file is lazily loaded and thus can be comparable large.
2. Ad-hoc: Key/value records can be added with add(Object...), add(Iterable), and add(GenericTestRecords). Please note that the actual amount of records for a test case as the GenericTestPlan already involves a certain degree of overhead.
   
   GenericTestRecords are directly comparable with equals and hashCode based on its content. Please note that in the case of large file-based GenericTestRecords, the time needed to compute the hashCode() or to compare two instances with equals(Object) can become quite long. Currently, the comparison result is order-dependent as GenericTestRecords are interpreted as a bags.
   

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericTestRecords() Initializes GenericTestRecords.
	GenericTestRecords(TypeConfig<T> typeConfig) Initializes GenericTestRecords with the given TypeConfig.

Method Summary

Methods

Modifier and Type	Method and Description
GenericTestRecords<T>	add(GenericTestRecords<T> records) Adds several records at once.
GenericTestRecords<T>	add(Iterable<? extends T> records) Adds several records at once.
GenericTestRecords<T>	add(T... records) Adds several records at once.
void	assertEquals(GenericTestRecords<T> expectedValues) Asserts that the contained set of records is equal to the set of records of the given GenericTestRecords.
void	close()
boolean	equals(Object obj)
protected List<T>	getRecords() Returns the records.
TypeConfig<T>	getTypeConfig() Returns the typeConfig.
int	hashCode()
boolean	isAdhoc() Returns true if any add method has been called at least one.
boolean	isInitialized() Returns true if either records were added manually or with load(Class, Configuration).
Iterator<T>	iterator()
Iterator<T>	iterator(TypeConfig<T> typeConfig) Retrieves an iterator over all entries sorted according to the provided TypeConfig.
GenericTestRecords<T>	load(Class<? extends eu.stratosphere.api.common.io.FileInputFormat> inputFormatClass, String file, eu.stratosphere.configuration.Configuration configuration) Initializes this GenericTestRecords from the given file.
GenericTestRecords<T>	load(Class<? extends eu.stratosphere.api.common.io.GenericInputFormat> inputFormatClass, eu.stratosphere.configuration.Configuration configuration) Initializes this GenericTestRecords from the given generic input.
void	saveToFile(String path) Saves the data to the given path in an internal format.
void	setEmpty() Specifies that the set of key/value records is empty.
void	setTypeConfig(TypeConfig<T> typeConfig) Sets the typeConfig to the specified value.
String	toString()
Iterator<T>	unsortedIterator() Returns an Iterator that iterates through the records as they are provided by the ad hoc expression or the file.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenericTestRecords

public GenericTestRecords(TypeConfig<T> typeConfig)

Initializes GenericTestRecords with the given TypeConfig.

Parameters:

typeConfig -

GenericTestRecords

protected GenericTestRecords()

Initializes GenericTestRecords.

Method Detail

add

public GenericTestRecords<T> add(GenericTestRecords<T> records)

Adds several records at once.

Parameters:

records - the records to add

Returns:

this

add

public GenericTestRecords<T> add(Iterable<? extends T> records)

Adds several records at once.

Parameters:

records - the records to add

Returns:

this

add

public GenericTestRecords<T> add(T... records)

Adds several records at once.

Parameters:

records - the records to add

Returns:

this

assertEquals

public void assertEquals(GenericTestRecords<T> expectedValues)
                  throws AssertionError

Asserts that the contained set of records is equal to the set of records of the given GenericTestRecords.

Parameters:

expectedValues - the other GenericTestRecords defining the expected result

Throws:

AssertionError - if the sets differ

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getTypeConfig

public TypeConfig<T> getTypeConfig()

Returns the typeConfig.

Returns:

the typeConfig

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAdhoc

public boolean isAdhoc()

Returns true if any add method has been called at least one.

Returns:

true if records were specified in an ad-hoc manner

isInitialized

public boolean isInitialized()

Returns true if either records were added manually or with load(Class, Configuration).

Returns:

true if either records were added manually or with load(Class, Configuration).

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

iterator

public Iterator<T> iterator(TypeConfig<T> typeConfig)

Retrieves an iterator over all entries sorted according to the provided TypeConfig.

Parameters:

typeConfig -

Returns:

the iterator

load

public GenericTestRecords<T> load(Class<? extends eu.stratosphere.api.common.io.FileInputFormat> inputFormatClass,
                         String file,
                         eu.stratosphere.configuration.Configuration configuration)

Initializes this GenericTestRecords from the given file.

Parameters:

inputFormatClass - the class of the FileInputFormat

file - the path to the file, can be relative

configuration - the configuration for the FileInputFormat.

Returns:

this

load

public GenericTestRecords<T> load(Class<? extends eu.stratosphere.api.common.io.GenericInputFormat> inputFormatClass,
                         eu.stratosphere.configuration.Configuration configuration)

Initializes this GenericTestRecords from the given generic input.

Parameters:

inputFormatClass - the class of the FileInputFormat

configuration - the configuration for the FileInputFormat.

Returns:

this

saveToFile

public void saveToFile(String path)
                throws IOException

Saves the data to the given path in an internal format.

Parameters:

path - the path to write to, may be relative

Throws:

IOException - if an I/O error occurred

setEmpty

public void setEmpty()

Specifies that the set of key/value records is empty. This method is primarily used to distinguish between an empty uninitialized set and a set deliberately left empty. Further calls to add(Object...) will reset the effect of this method invocation and vice-versa.

setTypeConfig

public void setTypeConfig(TypeConfig<T> typeConfig)

Sets the typeConfig to the specified value.

Parameters:

typeConfig - the typeConfig to set

toString

public String toString()

Overrides:

toString in class Object

unsortedIterator

public Iterator<T> unsortedIterator()

Returns an Iterator that iterates through the records as they are provided by the ad hoc expression or the file. Note that this iterator is not guaranteed to provide a result that is different from iterator(). It simply skips the sorting step, it will not shuffle sorted records.

Returns:

an Iterator that iterates through the records as they are provided by the ad hoc expression or the file.

getRecords

protected List<T> getRecords()

Returns the records.

Returns:

the records