com.asakusafw.vocabulary.flow.util

Class CoreOperatorFactory

java.lang.Object

com.asakusafw.vocabulary.flow.util.CoreOperatorFactory

public class CoreOperatorFactory
extends Object

Provides factory methods for core operators.

Since:

0.1.0

Version:

0.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoreOperatorFactory.Checkpoint<T> Represents a checkpoint operator which provides restarting point for (partial) failures.
static class	CoreOperatorFactory.Confluent<T> Represents a confluent operator which provides union of data-sets.
static class	CoreOperatorFactory.Empty<T> Represents an empty operator which provides empty data-sets.
static class	CoreOperatorFactory.EmptyFragment An empty operator fragment which requires the target type.
static class	CoreOperatorFactory.Extend<T> Represents a extend operator which transforms data model objects into other data model types.
static class	CoreOperatorFactory.ExtendFragment An extend operator fragment which requires the target type.
static class	CoreOperatorFactory.Project<T> Represents a project operator which transforms data model objects into other data model types.
static class	CoreOperatorFactory.ProjectFragment An project operator fragment which requires the target type.
static class	CoreOperatorFactory.Restructure<T> Represents a restructure operator which transforms data model objects into other data model types.
static class	CoreOperatorFactory.RestructureFragment An restructure operator fragment which requires the target type.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECKPOINT_NAME The common instance name of checkpoint operator.
static String	CONFLUENT_NAME The common instance name of confluent operator.
static String	EMPTY_NAME The common instance name of empty operator.
static String	EXTEND_NAME The common instance name of extend operator.
static String	PROJECT_NAME The common instance name of project operator.
static String	RESTRUCTURE_NAME The common instance name of restructure operator.
static String	STOP_NAME The common instance name of stop operator.

Constructor Summary

Constructors

Constructor and Description
CoreOperatorFactory()

Method Summary

Modifier and Type	Method and Description
<T> CoreOperatorFactory.Checkpoint<T>	checkpoint(Source<T> in) Returns a new checkpoint operator.
<T> CoreOperatorFactory.Confluent<T>	confluent(Iterable<? extends Source<T>> inputs) Returns a new confluent operator instance.
<T> CoreOperatorFactory.Confluent<T>	confluent(Source<T>... inputs) Returns a new confluent operator instance.
<T> CoreOperatorFactory.Confluent<T>	confluent(Source<T> a, Source<T> b) Returns a new confluent operator instance.
<T> CoreOperatorFactory.Confluent<T>	confluent(Source<T> a, Source<T> b, Source<T> c) Returns a new confluent operator instance.
<T> CoreOperatorFactory.Confluent<T>	confluent(Source<T> a, Source<T> b, Source<T> c, Source<T> d) Returns a new confluent operator instance.
CoreOperatorFactory.EmptyFragment	empty() Returns a new fragment which will be provide an empty operator.
<T> CoreOperatorFactory.Empty<T>	empty(Class<T> type) Returns a new empty operator instance.
<T> CoreOperatorFactory.Empty<T>	empty(Type type) Returns a new empty operator instance.
CoreOperatorFactory.ExtendFragment	extend(Source<?> in) Returns a new fragment which will be provide an extend operator.
<T> CoreOperatorFactory.Extend<T>	extend(Source<?> in, Class<T> targetType) Returns a new extend operator instance.
CoreOperatorFactory.ProjectFragment	project(Source<?> in) Returns a new fragment which will be provide a project operator.
<T> CoreOperatorFactory.Project<T>	project(Source<?> in, Class<T> targetType) Returns a new project operator instance.
CoreOperatorFactory.RestructureFragment	restructure(Source<?> in) Returns a new fragment which will be provide a restructure operator.
<T> CoreOperatorFactory.Restructure<T>	restructure(Source<?> in, Class<T> targetType) Returns a new restructure operator instance.
void	stop(Source<?> in) Terminates the upstream source.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_NAME

public static final String EMPTY_NAME

The common instance name of empty operator.

See Also:

Constant Field Values

STOP_NAME

public static final String STOP_NAME

The common instance name of stop operator.

See Also:

Constant Field Values

CONFLUENT_NAME

public static final String CONFLUENT_NAME

The common instance name of confluent operator.

See Also:

Constant Field Values

CHECKPOINT_NAME

public static final String CHECKPOINT_NAME

The common instance name of checkpoint operator.

See Also:

Constant Field Values

PROJECT_NAME

public static final String PROJECT_NAME

The common instance name of project operator.

See Also:

Constant Field Values

EXTEND_NAME

public static final String EXTEND_NAME

The common instance name of extend operator.

See Also:

Constant Field Values

RESTRUCTURE_NAME

public static final String RESTRUCTURE_NAME

The common instance name of restructure operator.

See Also:

Constant Field Values

Constructor Detail

CoreOperatorFactory

public CoreOperatorFactory()

Method Detail

empty

public <T> CoreOperatorFactory.Empty<T> empty(Class<T> type)

Returns a new empty operator instance. The resulting operator acts like a dummy input which provides an empty data-sets.

Type Parameters:

T - the data model type

Parameters:

type - the data model type

Returns:

a new instance of empty operator

Throws:

IllegalArgumentException - if the parameter is null

See Also:

Empty

empty

public <T> CoreOperatorFactory.Empty<T> empty(Type type)

Returns a new empty operator instance. The resulting operator acts like a dummy input which provides an empty data-sets.

Type Parameters:

T - the data model type

Parameters:

type - the data model type

Returns:

a new instance of empty operator

Throws:

IllegalArgumentException - if the parameter is null

See Also:

Empty

empty

public CoreOperatorFactory.EmptyFragment empty()

Returns a new fragment which will be provide an empty operator. The resulting object will require the target (downstream) data model type.

Returns:

a new fragment of empty operator

Since:

0.7.3

See Also:

empty(Class)

stop

public void stop(Source<?> in)

Terminates the upstream source. Generally, each operator output must be connected to at least one operator inputs (or flow outputs) for terminating data flow. This method internally connects the upstream source to a stop operator input. It operator will do nothing for any inputs and just drops them.

Parameters:

in - the upstream source

Throws:

IllegalArgumentException - if the parameter is null

See Also:

Stop

confluent

public <T> CoreOperatorFactory.Confluent<T> confluent(Source<T> a,
                                                      Source<T> b)

Returns a new confluent operator instance. The resulting operator puts the data from each upstream source together and provides them as the output.

Type Parameters:

T - the data model type

Parameters:

a - the upstream source (1)

b - the upstream source (2)

Returns:

a new instance of confluent operator

Throws:

IllegalArgumentException - if the parameters are null

See Also:

Confluent

confluent

public <T> CoreOperatorFactory.Confluent<T> confluent(Source<T> a,
                                                      Source<T> b,
                                                      Source<T> c)

Returns a new confluent operator instance. The resulting operator puts the data from each upstream source together and provides them as the output.

Type Parameters:

T - the data model type

Parameters:

a - the upstream source (1)

b - the upstream source (2)

c - the upstream source (3)

Returns:

a new instance of confluent operator

Throws:

IllegalArgumentException - if the parameters are null

See Also:

Confluent

confluent

public <T> CoreOperatorFactory.Confluent<T> confluent(Source<T> a,
                                                      Source<T> b,
                                                      Source<T> c,
                                                      Source<T> d)

Returns a new confluent operator instance. The resulting operator puts the data from each upstream source together and provides them as the output.

Type Parameters:

T - the data model type

Parameters:

a - the upstream source (1)

b - the upstream source (2)

c - the upstream source (3)

d - the upstream source (4)

Returns:

a new instance of confluent operator

Throws:

IllegalArgumentException - if the parameters are null

See Also:

Confluent

confluent

public <T> CoreOperatorFactory.Confluent<T> confluent(Iterable<? extends Source<T>> inputs)

Returns a new confluent operator instance. The resulting operator puts the data from each upstream source together and provides them as the output.

Type Parameters:

T - the data model type

Parameters:

inputs - the upstream sources

Returns:

a new instance of confluent operator

Throws:

IllegalArgumentException - if the parameter is null

See Also:

Confluent

confluent

@SafeVarargs
public final <T> CoreOperatorFactory.Confluent<T> confluent(Source<T>... inputs)

Returns a new confluent operator instance. The resulting operator puts the data from each upstream source together and provides them as the output.

Type Parameters:

T - the data model type

Parameters:

inputs - the upstream sources

Returns:

a new instance of confluent operator

Throws:

IllegalArgumentException - if the parameter is null

Since:

0.9.0

See Also:

Confluent

checkpoint

public <T> CoreOperatorFactory.Checkpoint<T> checkpoint(Source<T> in)

Returns a new checkpoint operator. The resulting operator will provide a restarting point for the (partial) failure. Note that, this will acts as an identity operator in some implementations, because the checkpoint is an optional operation.

Type Parameters:

T - the data model type

Parameters:

in - the upstream source

Returns:

a new instance of checkpoint operator

Throws:

IllegalArgumentException - if the parameter is null

See Also:

Checkpoint

project

public <T> CoreOperatorFactory.Project<T> project(Source<?> in,
                                                  Class<T> targetType)

Returns a new project operator instance. The source (upstream) data type must have all properties declared in the target (downstream) data type. This operator will copy such properties in the upstream data into the each resulting data. If the target data model type has extra properties for the upstream data type, or if there are type incompatible properties between the source and target data model, compiling this operator must be failed.

Type Parameters:

T - the target data model type

Parameters:

in - the upstream source

targetType - the target data model class

Returns:

a new instance of project operator

Throws:

IllegalArgumentException - if the parameters are null

Since:

0.2.0

See Also:

project(Source), Project

project

public CoreOperatorFactory.ProjectFragment project(Source<?> in)

Returns a new fragment which will be provide a project operator. The resulting fragment object will require the target (downstream) data model type.

Parameters:

in - the upstream source

Returns:

a new fragment of project operator

Throws:

IllegalArgumentException - if the parameters are null

Since:

0.7.3

See Also:

project(Source, Class)

extend

public <T> CoreOperatorFactory.Extend<T> extend(Source<?> in,
                                                Class<T> targetType)

Returns a new extend operator instance. The target (downstream) data type must have all properties declared in the source (upstream) data type. This operator will copy such properties in the upstream data into the each resulting data. If the target data model type does not have some properties in the upstream data type, or if there are type incompatible properties between the source and target data model, compiling this operator must be failed.

Type Parameters:

T - the target data model type

Parameters:

in - the upstream source

targetType - the target data model class

Returns:

a new instance of extend operator

Throws:

IllegalArgumentException - if the parameters are null

Since:

0.2.0

See Also:

extend(Source), Extend

extend

public CoreOperatorFactory.ExtendFragment extend(Source<?> in)

Returns a new fragment which will be provide an extend operator. The resulting fragment object will require the target (downstream) data model type.

Parameters:

in - the upstream source

Returns:

a new fragment of extend operator

Throws:

IllegalArgumentException - if the parameters are null

Since:

0.7.3

See Also:

extend(Source, Class)

restructure

public <T> CoreOperatorFactory.Restructure<T> restructure(Source<?> in,
                                                          Class<T> targetType)

Returns a new restructure operator instance. The target (downstream) data type must have one or more properties declared in the source (upstream) data type. This operator will copy such properties in the upstream data into the each resulting data. If there are type incompatible properties between the source and target data model, compiling this operator must be failed.

Type Parameters:

T - the target data model type

Parameters:

in - the upstream source

targetType - the target data model class

Returns:

a new instance of restructure operator

Throws:

IllegalArgumentException - if the parameters are null

Since:

0.2.1

See Also:

restructure(Source), Restructure

restructure

public CoreOperatorFactory.RestructureFragment restructure(Source<?> in)

Returns a new fragment which will be provide a restructure operator. The resulting fragment object will require the target (downstream) data model type.

Parameters:

in - the upstream source

Returns:

a new fragment of restructure operator

Throws:

IllegalArgumentException - if the parameters are null

Since:

0.7.3

See Also:

restructure(Source, Class)