eu.stratosphere.core.testing

Class GenericTestPlan<T,Records extends GenericTestRecords<T>>

java.lang.Object

eu.stratosphere.core.testing.GenericTestPlan<T,Records>

Type Parameters:

T - the record type

Records - record type-specific GenericTestRecords

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

TestPlan

public abstract class GenericTestPlan<T,Records extends GenericTestRecords<T>>
extends Object
implements Closeable

Base class for type-specific test plans. See TestPlan for the core Record implementation.

Constructor Summary

Constructors

Constructor and Description
GenericTestPlan(TypeConfig<T> defaultConfig, Collection<? extends eu.stratosphere.api.common.operators.Operator> contracts) Initializes TestPlan with the given Operators.
GenericTestPlan(TypeConfig<T> defaultConfig, eu.stratosphere.api.common.operators.Operator... contracts) Initializes TestPlan with the given Operators.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
static eu.stratosphere.api.common.operators.FileDataSink	createDefaultSink(String name, TypeConfig<?> typeConfig) Creates a default sink with the given name.
static eu.stratosphere.api.common.operators.FileDataSource	createDefaultSource(String name, TypeConfig<?> typeConfig) Creates a default source with the given name.
protected eu.stratosphere.api.common.Plan	createPlan(Collection<eu.stratosphere.api.common.operators.GenericDataSink> wrappedSinks) Creates the actual plan for the given sinks.
protected abstract Records	createTestRecords(TypeConfig<T> typeConfig) Creates the concrete implementation of GenericTestRecords for this plan.
Records	getActualOutput() Returns the first output GenericTestRecords of the TestPlan associated with the given sink.
Records	getActualOutput(eu.stratosphere.api.common.operators.GenericDataSink sink) Returns the output GenericTestRecords of the TestPlan associated with the given sink.
Records	getActualOutput(eu.stratosphere.api.common.operators.GenericDataSink sink, TypeConfig<T> typeConfig) Returns the output GenericTestRecords of the TestPlan associated with the given sink.
Records	getActualOutput(int number) Returns the output GenericTestRecords associated with the ith output of the TestPlan.
Records	getActualOutput(int sinkNumber, TypeConfig<T> typeConfig) Returns the output GenericTestRecords of the TestPlan associated with the ith sink. The values are only meaningful after a run().
Records	getActualOutput(TypeConfig<T> typeConfig) Returns the first output GenericTestRecords of the TestPlan associated with the given sink.
protected TypeConfig<T>	getDefaultConfig() Returns the defaultConfig.
int	getDegreeOfParallelism() Returns the degreeOfParallelism.
Records	getExpectedOutput(eu.stratosphere.api.common.operators.GenericDataSink sink, TypeConfig<T> typeConfig) Returns the expected output GenericTestRecords with the given TypeConfig of the TestPlan associated with the given sink.
Records	getExpectedOutput(int number, TypeConfig<T> typeConfig) Returns the expected output GenericTestRecords associated with the ith expected output of the TestPlan.
Records	getExpectedOutput(TypeConfig<T> typeConfig) Returns the first expected output GenericTestRecords of the TestPlan.
Records	getInput() Returns the first input GenericTestRecords of the TestPlan.
Records	getInput(eu.stratosphere.api.common.operators.GenericDataSource<?> source) Returns the input GenericTestRecords of the TestPlan associated with the given source.
Records	getInput(eu.stratosphere.api.common.operators.GenericDataSource<?> source, TypeConfig<T> typeConfig) Returns the input GenericTestRecords of the TestPlan associated with the given source.
Records	getInput(int number) Returns the input GenericTestRecords associated with the ith input of the TestPlan.
Records	getInput(int number, TypeConfig<T> typeConfig) Returns the input GenericTestRecords associated with the ith input of the TestPlan.
eu.stratosphere.api.common.operators.Operator	getOutputOfOperator(eu.stratosphere.api.common.operators.Operator contract) Traverses the test plan and returns the first contracts that process the data of the given contract.
eu.stratosphere.api.common.operators.Operator[]	getOutputsOfOperator(eu.stratosphere.api.common.operators.Operator contract) Traverses the test plan and returns all contracts that process the data of the given contract.
List<eu.stratosphere.api.common.operators.GenericDataSink>	getSinks() Returns all GenericDataSinks of this test plan.
List<eu.stratosphere.api.common.operators.GenericDataSource<?>>	getSources() Returns the sources.
void	run() Compiles the plan to an Plan and executes it.
protected void	setDefaultConfig(TypeConfig<T> defaultConfig) Sets the defaultConfig to the specified value.
void	setDegreeOfParallelism(int degreeOfParallelism) Sets the degreeOfParallelism to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericTestPlan

public GenericTestPlan(TypeConfig<T> defaultConfig,
               Collection<? extends eu.stratosphere.api.common.operators.Operator> contracts)

Initializes TestPlan with the given Operators. Like the original Plan, the contracts may be GenericDataSinks. However, it is also possible to add arbitrary Operators, to which GenericDataSinkOperators are automatically added.

Parameters:

defaultConfig - the TypeConfig that is used for the plan if no specific config is given

contracts - a list of Operators with at least one element.

GenericTestPlan

public GenericTestPlan(TypeConfig<T> defaultConfig,
               eu.stratosphere.api.common.operators.Operator... contracts)

Initializes TestPlan with the given Operators. Like the original Plan, the contracts may be GenericDataSinks. However, it is also possible to add arbitrary Operators, to which GenericDataSinkOperators are automatically added.

Parameters:

defaultConfig - the TypeConfig that is used for the plan if no specific config is given

contracts - a list of Operators with at least one element.

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getActualOutput

public Records getActualOutput()

Returns the first output GenericTestRecords of the TestPlan associated with the given sink. This is the recommended method to get output records for more complex TestPlans.
The values are only meaningful after a run().

Returns:

the output GenericTestRecords of the TestPlan associated with the first sink

getActualOutput

public Records getActualOutput(eu.stratosphere.api.common.operators.GenericDataSink sink)

Returns the output GenericTestRecords of the TestPlan associated with the given sink. This is the recommended method to get output records for more complex TestPlans.
The values are only meaningful after a run().

Parameters:

sink - the sink of which the associated output GenericTestRecords should be returned

Returns:

the output GenericTestRecords of the TestPlan associated with the given sink

getActualOutput

public Records getActualOutput(eu.stratosphere.api.common.operators.GenericDataSink sink,
                      TypeConfig<T> typeConfig)

Returns the output GenericTestRecords of the TestPlan associated with the given sink. This is the recommended method to get output records for more complex TestPlans.
The values are only meaningful after a run().

Parameters:

typeConfig - the TypeConfig that is used for this output

sink - the sink of which the associated output GenericTestRecords should be returned

Returns:

the output GenericTestRecords of the TestPlan associated with the given sink

getActualOutput

public Records getActualOutput(int number)

Returns the output GenericTestRecords associated with the ith output of the TestPlan. If multiple contracts are tested in the TestPlan, it is recommended to use the getActualOutput(GenericDataSink) method to unambiguously get the values.
The values are only meaningful after a run().

Parameters:

number - the number of the output.

Returns:

the ith output of the TestPlan

getActualOutput

public Records getActualOutput(int sinkNumber,
                      TypeConfig<T> typeConfig)

Returns the output GenericTestRecords of the TestPlan associated with the ith sink.
The values are only meaningful after a run().

Parameters:

typeConfig - the TypeConfig that is used for this output

sinkNumber - the ith sink of which the associated output GenericTestRecords should be returned

Returns:

the ith output of the TestPlan

getActualOutput

public Records getActualOutput(TypeConfig<T> typeConfig)

Returns the first output GenericTestRecords of the TestPlan associated with the given sink. This is the recommended method to get output records for more complex TestPlans.
The values are only meaningful after a run().

Parameters:

typeConfig - the TypeConfig that is used for this output

Returns:

the output GenericTestRecords of the TestPlan associated with the first sink

getDegreeOfParallelism

public int getDegreeOfParallelism()

Returns the degreeOfParallelism.

Returns:

the degreeOfParallelism

getExpectedOutput

public Records getExpectedOutput(eu.stratosphere.api.common.operators.GenericDataSink sink,
                        TypeConfig<T> typeConfig)

Returns the expected output GenericTestRecords with the given TypeConfig of the TestPlan associated with the given sink. This is the recommended method to set expected output records for more complex TestPlans.

Parameters:

sink - the sink of which the associated expected output GenericTestRecords should be returned

typeConfig - the TypeConfig that should be used to create a new GenericTestRecords if needed

Returns:

the expected output GenericTestRecords of the TestPlan associated with the given sink

getExpectedOutput

public Records getExpectedOutput(int number,
                        TypeConfig<T> typeConfig)

Returns the expected output GenericTestRecords associated with the ith expected output of the TestPlan. If multiple contracts are tested in the TestPlan, it is recommended to use the getExpectedOutput(GenericDataSink, TypeConfig) method to unambiguously set the values.

Parameters:

typeConfig - the TypeConfig that should be used to create a new GenericTestRecords if needed

number - the number of the expected output.

Returns:

the ith expected output of the TestPlan

getExpectedOutput

public Records getExpectedOutput(TypeConfig<T> typeConfig)

Returns the first expected output GenericTestRecords of the TestPlan. If multiple contracts are tested in the TestPlan, it is recommended to use the getExpectedOutput(GenericDataSink, TypeConfig) method to unambiguously set the values.

Parameters:

typeConfig -

Returns:

the first expected output of the TestPlan

getInput

public Records getInput()

Returns the first input GenericTestRecords of the TestPlan. If multiple contracts are tested in the TestPlan, it is recommended to use the getInput(GenericDataSource) method to unambiguously set the values.

Returns:

the first input of the TestPlan

getInput

public Records getInput(eu.stratosphere.api.common.operators.GenericDataSource<?> source)

Returns the input GenericTestRecords of the TestPlan associated with the given source. This is the recommended method to set input records for more complex TestPlans.

Parameters:

source - the source of which the associated input GenericTestRecords should be returned

Returns:

the input GenericTestRecords of the TestPlan associated with the given source

getInput

public Records getInput(eu.stratosphere.api.common.operators.GenericDataSource<?> source,
               TypeConfig<T> typeConfig)

Returns the input GenericTestRecords of the TestPlan associated with the given source. This is the recommended method to set input records for more complex TestPlans.

Parameters:

typeConfig - the TypeConfig that should be used to create a new GenericTestRecords if needed

source - the source of which the associated input GenericTestRecords should be returned

Returns:

the input GenericTestRecords of the TestPlan associated with the given source

getInput

public Records getInput(int number)

Returns the input GenericTestRecords associated with the ith input of the TestPlan. If multiple contracts are tested in the TestPlan, it is recommended to use the getInput(GenericDataSource) method to unambiguously set the values.

Parameters:

number - the number of the input.

Returns:

the ith input of the TestPlan

getInput

public Records getInput(int number,
               TypeConfig<T> typeConfig)

Returns the input GenericTestRecords associated with the ith input of the TestPlan. If multiple contracts are tested in the TestPlan, it is recommended to use the getInput(GenericDataSource, TypeConfig) method to unambiguously set the values.

Parameters:

number - the number of the input.

typeConfig - the TypeConfig that should be used to create a new GenericTestRecords if needed

Returns:

the ith input of the TestPlan

getOutputOfOperator

public eu.stratosphere.api.common.operators.Operator getOutputOfOperator(eu.stratosphere.api.common.operators.Operator contract)

Traverses the test plan and returns the first contracts that process the data of the given contract.

Parameters:

contract - the contract of which one preceding contracts should be returned

Returns:

returns the first contract that process the data of the given contract

getOutputsOfOperator

public eu.stratosphere.api.common.operators.Operator[] getOutputsOfOperator(eu.stratosphere.api.common.operators.Operator contract)

Traverses the test plan and returns all contracts that process the data of the given contract.

Parameters:

contract - the contract of which preceding contracts should be returned

Returns:

returns all contracts that process the data of the given contract

getSinks

public List<eu.stratosphere.api.common.operators.GenericDataSink> getSinks()

Returns all GenericDataSinks of this test plan.

Returns:

the sinks

getSources

public List<eu.stratosphere.api.common.operators.GenericDataSource<?>> getSources()

Returns the sources.

Returns:

the sources

run

public void run()

Compiles the plan to an Plan and executes it. If expected values have been specified, the actual outputs values are compared to the expected values.

setDegreeOfParallelism

public void setDegreeOfParallelism(int degreeOfParallelism)

Sets the degreeOfParallelism to the specified value.

Parameters:

degreeOfParallelism - the degreeOfParallelism to set

createPlan

protected eu.stratosphere.api.common.Plan createPlan(Collection<eu.stratosphere.api.common.operators.GenericDataSink> wrappedSinks)

Creates the actual plan for the given sinks.

Parameters:

wrappedSinks - the sinks

Returns:

the plan

createTestRecords

protected abstract Records createTestRecords(TypeConfig<T> typeConfig)

Creates the concrete implementation of GenericTestRecords for this plan.

Parameters:

typeConfig - the TypeConfig to use

Returns:

the test records

getDefaultConfig

protected TypeConfig<T> getDefaultConfig()

Returns the defaultConfig.

Returns:

the defaultConfig

setDefaultConfig

protected void setDefaultConfig(TypeConfig<T> defaultConfig)

Sets the defaultConfig to the specified value.

Parameters:

defaultConfig - the defaultConfig to set

createDefaultSink

public static eu.stratosphere.api.common.operators.FileDataSink createDefaultSink(String name,
                                                                  TypeConfig<?> typeConfig)

Creates a default sink with the given name. This sink may be used with ad-hoc values added to the corresponding GenericTestRecords.

Parameters:

name - the name of the sink

typeConfig - the TypeConfig used in SequentialOutputFormat

Returns:

the created sink

createDefaultSource

public static eu.stratosphere.api.common.operators.FileDataSource createDefaultSource(String name,
                                                                      TypeConfig<?> typeConfig)

Creates a default source with the given name. This sink may be used with ad-hoc values added to the corresponding GenericTestRecords.

Parameters:

name - the name of the source

typeConfig - the TypeConfig used in SequentialInputFormat

Returns:

the created source