com.asakusafw.testdriver

Class FlowDriverOutput<T,S extends FlowDriverOutput<T,S>>

java.lang.Object

com.asakusafw.testdriver.DriverElementBase

com.asakusafw.testdriver.DriverInputBase<T>

com.asakusafw.testdriver.DriverOutputBase<T>

com.asakusafw.testdriver.FlowDriverOutput<T,S>

Type Parameters:

T - the output data model type

S - the implementation class type

Direct Known Subclasses:

FlowPartDriverOutput, JobFlowDriverOutput

public abstract class FlowDriverOutput<T,S extends FlowDriverOutput<T,S>>
extends DriverOutputBase<T>

An abstract super class which represents an output port of data flow on testing. Clients should not inherit this class directly.

Since:

0.6.0

Version:

0.9.1

Constructor Summary

Constructors

Constructor and Description
FlowDriverOutput(Class<?> callerClass, TestDataToolProvider testTools, String name, Class<T> modelType) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
S	dumpActual(Class<? extends DataFormat<? super T>> formatClass, File outputPath) Enables to store the result data set of this output.
S	dumpActual(DataModelSinkFactory factory) Sets the result data sink for this output.
S	dumpActual(File outputPath) Enables to store the result data set of this output.
S	dumpActual(String outputPath) Enables to store the result data set of this output.
S	dumpDifference(DifferenceSinkFactory factory) Sets the result differences sink for this output.
S	dumpDifference(File outputPath) Enables to store the result differences of this output.
S	dumpDifference(String outputPath) Enables to store the result differences of this output.
S	filter(UnaryOperator<DataModelSource> filter) Sets the result data set filter for this output.
protected abstract S	getThis() Returns this object.
S	prepare(Class<? extends DataFormat<? super T>> formatClass, File sourceFile) Sets the test data set for this input.
S	prepare(Class<? extends DataFormat<? super T>> formatClass, String sourcePath) Sets the test data set for this input.
S	prepare(DataModelSourceFactory factory) Sets the initial data set for this output.
S	prepare(DataModelSourceFactory factory, Consumer<? super T> transformer) Sets the test data set for this output.
S	prepare(Iterable<? extends T> objects) Sets the initial data set for this output.
S	prepare(Provider<? extends Source<? extends T>> provider) Sets the initial data set for this output.
S	prepare(String sourcePath) Sets the initial data set for this output.
S	transform(Consumer<? super T> transformer) Enables to transform the result data before verifying the results of this output.
S	transform(ModelTransformer<? super T> transformer) Enables to transform the result data before verifying the results of this output.
S	verify(Class<? extends DataFormat<? super T>> formatClass, File expectedFile, ModelVerifier<? super T> modelVerifier) Enables to verify the results of this output.
S	verify(Class<? extends DataFormat<? super T>> formatClass, File expectedFile, String verifyRulePath) Enables to verify the results of this output.
S	verify(Class<? extends DataFormat<? super T>> formatClass, File expectedFile, String verifyRulePath, ModelTester<? super T> tester) Enables to verify the results of this output.
S	verify(Class<? extends DataFormat<? super T>> formatClass, String expectedPath, ModelVerifier<? super T> modelVerifier) Enables to verify the results of this output.
S	verify(Class<? extends DataFormat<? super T>> formatClass, String expectedPath, String verifyRulePath) Enables to verify the results of this output.
S	verify(Class<? extends DataFormat<? super T>> formatClass, String expectedPath, String verifyRulePath, ModelTester<? super T> tester) Enables to verify the results of this output.
S	verify(DataModelSourceFactory expectedFactory, ModelVerifier<? super T> modelVerifier) Enables to verify the results of this output.
S	verify(DataModelSourceFactory expectedFactory, String verifyRulePath) Enables to verify the results of this output.
S	verify(DataModelSourceFactory expectedFactory, String verifyRulePath, ModelTester<? super T> tester) Enables to verify the results of this output.
S	verify(Iterable<? extends T> expectedObjects, ModelVerifier<? super T> modelVerifier) Enables to verify the results of this output.
S	verify(Iterable<? extends T> expectedObjects, String verifyRulePath) Enables to verify the results of this output.
S	verify(Iterable<? extends T> expectedObjects, String verifyRulePath, ModelTester<? super T> tester) Enables to verify the results of this output.
S	verify(Provider<? extends Source<? extends T>> expectedProvider, ModelVerifier<? super T> modelVerifier) Enables to verify the results of this output.
S	verify(Provider<? extends Source<? extends T>> expectedProvider, String verifyRulePath) Enables to verify the results of this output.
S	verify(Provider<? extends Source<? extends T>> expectedProvider, String verifyRulePath, ModelTester<? super T> tester) Enables to verify the results of this output.
S	verify(String expectedPath, ModelVerifier<? super T> modelVerifier) Enables to verify the results of this output.
S	verify(String expectedPath, String verifyRulePath) Enables to verify the results of this output.
S	verify(String expectedPath, String verifyRulePath, ModelTester<? super T> tester) Enables to verify the results of this output.
S	verify(VerifierFactory factory) Sets how verify the execution results for this output.
S	with(Consumer<? super S> configurator) Configures this object.

Methods inherited from class com.asakusafw.testdriver.DriverOutputBase

getDifferenceSink, getResultSink, getVerifier, setDifferenceSink, setResultFilter, setResultSink, setVerifier, toDataModelSinkFactory, toDataModelSinkFactory, toDifferenceSinkFactory, toDifferenceSinkFactory, toVerifierFactory, toVerifyRuleFactory, toVerifyRuleFactory

Methods inherited from class com.asakusafw.testdriver.DriverInputBase

getCallerClass, getDataModelDefinition, getModelType, getName, getSource, getTestTools, setSource, toDataModelSourceFactory, toDataModelSourceFilter

Methods inherited from class com.asakusafw.testdriver.DriverElementBase

toDataModelSinkFactory, toDataModelSourceFactory, toDataModelSourceFactory, toDataModelSourceFactory, toDataModelSourceFactory, toDataModelSourceFactory, toDataModelSourceFilter, toOutputUri, toUri, toVerifierFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowDriverOutput

public FlowDriverOutput(Class<?> callerClass,
                        TestDataToolProvider testTools,
                        String name,
                        Class<T> modelType)

Creates a new instance.

Parameters:

callerClass - the current context class

testTools - the test data tools

name - the original input name

modelType - the data model type

Since:

0.6.0

Method Detail

getThis

protected abstract S getThis()

Returns this object.

Returns:

this

Since:

0.6.0

prepare

public S prepare(DataModelSourceFactory factory)

Sets the initial data set for this output.

Parameters:

factory - factory which provides test data set

Returns:

this

Since:

0.6.0

prepare

public S prepare(DataModelSourceFactory factory,
                 Consumer<? super T> transformer)

Sets the test data set for this output.

Parameters:

factory - factory which provides test data set

transformer - the input source transformer

Returns:

this

Since:

0.10.2

verify

public S verify(VerifierFactory factory)

Sets how verify the execution results for this output.

Parameters:

factory - factory which provides result verifier

Returns:

this

Since:

0.2.3

filter

public S filter(UnaryOperator<DataModelSource> filter)

Sets the result data set filter for this output. This can select or transform the results before verifying them.

Parameters:

filter - the data set filter

Returns:

this

Since:

0.7.0

dumpActual

public S dumpActual(DataModelSinkFactory factory)

Sets the result data sink for this output.

Parameters:

factory - factory which provides result data sink

Returns:

this

Since:

0.2.3

dumpDifference

public S dumpDifference(DifferenceSinkFactory factory)

Sets the result differences sink for this output.

Parameters:

factory - factory which provides result differences sink

Returns:

this

Since:

0.2.3

prepare

public S prepare(String sourcePath)

Sets the initial data set for this output.

Parameters:

sourcePath - path to the initial data set file

Returns:

this

Throws:

IllegalArgumentException - if the source was not found on the path

Since:

0.2.0

prepare

public S prepare(Iterable<? extends T> objects)

Sets the initial data set for this output.

Parameters:

objects - the initial data objects

Returns:

this

Since:

0.6.0

prepare

public S prepare(Provider<? extends Source<? extends T>> provider)

Sets the initial data set for this output.

Parameters:

provider - the expected data set provider

Returns:

this

Since:

0.6.0

prepare

public S prepare(Class<? extends DataFormat<? super T>> formatClass,
                 String sourcePath)

Sets the test data set for this input. Note that, the original source path may be changed if tracking source file name. To keep the source file path information, please use prepare(Class, File) instead.

Parameters:

formatClass - the data format class

sourcePath - the input file path on the class path

Returns:

this

Throws:

IllegalArgumentException - if the source is not valid for the given data format

Since:

0.9.1

prepare

public S prepare(Class<? extends DataFormat<? super T>> formatClass,
                 File sourceFile)

Sets the test data set for this input.

Parameters:

formatClass - the data format class

sourceFile - the input file

Returns:

this

Throws:

IllegalArgumentException - if the source is not valid for the given data format

Since:

0.9.1

verify

public S verify(DataModelSourceFactory expectedFactory,
                String verifyRulePath)

Enables to verify the results of this output.

Parameters:

expectedFactory - factory which provides the expected data set

verifyRulePath - the path to verification rule file

Returns:

this

Throws:

IllegalArgumentException - if the verification rule file was not found

Since:

0.6.0

verify

public S verify(String expectedPath,
                String verifyRulePath)

Enables to verify the results of this output.

Parameters:

expectedPath - the path to the expected data set file

verifyRulePath - the path to verification rule file

Returns:

this

Throws:

IllegalArgumentException - if either the expected data set or verification rule file was not found

Since:

0.2.0

verify

public S verify(Iterable<? extends T> expectedObjects,
                String verifyRulePath)

Enables to verify the results of this output.

Parameters:

expectedObjects - the expected data objects

verifyRulePath - the path to verification rule file

Returns:

this

Throws:

IllegalArgumentException - if the verification rule file was not found

Since:

0.6.0

verify

public S verify(Provider<? extends Source<? extends T>> expectedProvider,
                String verifyRulePath)

Enables to verify the results of this output.

Parameters:

expectedProvider - the expected data set provider

verifyRulePath - the path to verification rule file

Returns:

this

Throws:

IllegalArgumentException - if the verification rule file was not found

Since:

0.6.0

verify

public S verify(Class<? extends DataFormat<? super T>> formatClass,
                String expectedPath,
                String verifyRulePath)

Enables to verify the results of this output. Note that, the original source path may be changed if tracking source file name. To keep the source file path information, please use verify(Class, File, String) instead.

Parameters:

formatClass - the data format class

expectedPath - the path to the expected data set file on the class path

verifyRulePath - the path to verification rule file

Returns:

this

Throws:

IllegalArgumentException - if the source is not valid for the given data format

Since:

0.9.1

verify

public S verify(Class<? extends DataFormat<? super T>> formatClass,
                File expectedFile,
                String verifyRulePath)

Enables to verify the results of this output.

Parameters:

formatClass - the data format class

expectedFile - the expected data set file

verifyRulePath - the path to verification rule file

Returns:

this

Throws:

IllegalArgumentException - if the source is not valid for the given data format

Since:

0.9.1

verify

public S verify(DataModelSourceFactory expectedFactory,
                String verifyRulePath,
                ModelTester<? super T> tester)

Enables to verify the results of this output.

Parameters:

expectedFactory - factory which provides the expected data set

verifyRulePath - the path to verification rule file

tester - the extra verification rule for each data model object (nullable)

Returns:

this

Throws:

IllegalArgumentException - if the verification rule file was not found

Since:

0.6.0

verify

public S verify(String expectedPath,
                String verifyRulePath,
                ModelTester<? super T> tester)

Enables to verify the results of this output.

Parameters:

expectedPath - the path to the expected data set file

verifyRulePath - the path to verification rule file

tester - the extra verification rule for each data model object (nullable)

Returns:

this

Throws:

IllegalArgumentException - if either the expected data set or verification rule file was not found

Since:

0.2.3

verify

public S verify(Iterable<? extends T> expectedObjects,
                String verifyRulePath,
                ModelTester<? super T> tester)

Enables to verify the results of this output.

Parameters:

expectedObjects - the expected data objects

verifyRulePath - the path to verification rule file

tester - the extra verification rule for each data model object (nullable)

Returns:

this

Throws:

IllegalArgumentException - if the verification rule file was not found

Since:

0.6.0

verify

public S verify(Provider<? extends Source<? extends T>> expectedProvider,
                String verifyRulePath,
                ModelTester<? super T> tester)

Enables to verify the results of this output.

Parameters:

expectedProvider - the expected data set provider

verifyRulePath - the path to verification rule file

tester - the extra verification rule for each data model object (nullable)

Returns:

this

Throws:

IllegalArgumentException - if the verification rule file was not found

Since:

0.6.0

verify

public S verify(Class<? extends DataFormat<? super T>> formatClass,
                String expectedPath,
                String verifyRulePath,
                ModelTester<? super T> tester)

Enables to verify the results of this output. Note that, the original source path may be changed if tracking source file name. To keep the source file path information, please use verify(Class, String, String, ModelTester) instead.

Parameters:

formatClass - the data format class

expectedPath - the path to the expected data set file on the class path

verifyRulePath - the path to verification rule file

tester - the extra verification rule for each data model object (nullable)

Returns:

this

Throws:

IllegalArgumentException - if the source is not valid for the given data format

Since:

0.9.1

verify

public S verify(Class<? extends DataFormat<? super T>> formatClass,
                File expectedFile,
                String verifyRulePath,
                ModelTester<? super T> tester)

Enables to verify the results of this output.

Parameters:

formatClass - the data format class

expectedFile - the expected data set file

verifyRulePath - the path to verification rule file

tester - the extra verification rule for each data model object (nullable)

Returns:

this

Throws:

IllegalArgumentException - if the source is not valid for the given data format

Since:

0.9.1

verify

public S verify(DataModelSourceFactory expectedFactory,
                ModelVerifier<? super T> modelVerifier)

Enables to verify the results of this output.

Parameters:

expectedFactory - factory which provides the expected data set

modelVerifier - the verification rule

Returns:

this

Since:

0.6.0

verify

public S verify(String expectedPath,
                ModelVerifier<? super T> modelVerifier)

Enables to verify the results of this output.

Parameters:

expectedPath - the path to the expected data set file

modelVerifier - the verification rule

Returns:

this

Throws:

IllegalArgumentException - if either the expected data set or verification rule file was not found

Since:

0.2.0

verify

public S verify(Iterable<? extends T> expectedObjects,
                ModelVerifier<? super T> modelVerifier)

Enables to verify the results of this output.

Parameters:

expectedObjects - the expected data objects

modelVerifier - the verification rule

Returns:

this

Since:

0.6.0

verify

public S verify(Provider<? extends Source<? extends T>> expectedProvider,
                ModelVerifier<? super T> modelVerifier)

Enables to verify the results of this output.

Parameters:

expectedProvider - the expected data set provider

modelVerifier - the verification rule

Returns:

this

Since:

0.6.0

verify

public S verify(Class<? extends DataFormat<? super T>> formatClass,
                String expectedPath,
                ModelVerifier<? super T> modelVerifier)

Enables to verify the results of this output. Note that, the original source path may be changed if tracking source file name. To keep the source file path information, please use verify(Class, File, ModelVerifier) instead.

Parameters:

formatClass - the data format class

expectedPath - the path to the expected data set file on the class path

modelVerifier - the verification rule

Returns:

this

Throws:

IllegalArgumentException - if the source is not valid for the given data format

Since:

0.9.1

verify

public S verify(Class<? extends DataFormat<? super T>> formatClass,
                File expectedFile,
                ModelVerifier<? super T> modelVerifier)

Enables to verify the results of this output.

Parameters:

formatClass - the data format class

expectedFile - the expected data set file

modelVerifier - the verification rule

Returns:

this

Throws:

IllegalArgumentException - if the source is not valid for the given data format

Since:

0.9.1

transform

public S transform(Consumer<? super T> transformer)

Enables to transform the result data before verifying the results of this output.

Parameters:

transformer - the data model object transformer

Returns:

this

Since:

0.10.2

transform

public S transform(ModelTransformer<? super T> transformer)

Enables to transform the result data before verifying the results of this output.

Parameters:

transformer - the data model object transformer

Returns:

this

Since:

0.7.0

dumpActual

public S dumpActual(String outputPath)

Enables to store the result data set of this output.

Parameters:

outputPath - the output path

Returns:

this

Since:

0.2.3

dumpActual

public S dumpActual(File outputPath)

Enables to store the result data set of this output.

Parameters:

outputPath - the output path

Returns:

this

Since:

0.2.3

dumpActual

public S dumpActual(Class<? extends DataFormat<? super T>> formatClass,
                    File outputPath)

Enables to store the result data set of this output.

Parameters:

formatClass - the data format class

outputPath - the output path

Returns:

this

Since:

0.9.1

dumpDifference

public S dumpDifference(String outputPath)

Enables to store the result differences of this output.

Parameters:

outputPath - the output path

Returns:

this

Since:

0.2.3

dumpDifference

public S dumpDifference(File outputPath)

Enables to store the result differences of this output.

Parameters:

outputPath - the output path

Returns:

this

Since:

0.2.3

with

public S with(Consumer<? super S> configurator)

Configures this object.

Parameters:

configurator - the configurator

Returns:

this

Since:

0.10.2