com.asakusafw.vocabulary.flow.util

Class CoreOperators

java.lang.Object

com.asakusafw.vocabulary.flow.util.CoreOperators

public final class CoreOperators
extends Object

Provides factory methods for core operators.

Since:

0.2.6

Version:

0.9.0

Method Summary

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

Method Detail

empty

public static <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:

CoreOperatorFactory.empty(Class)

empty

public static 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:

CoreOperatorFactory.empty()

stop

public static void stop(Source<?> in)

Terminates the upstream source. Generally, operator outputs must be connected to at least one operator inputs 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:

CoreOperatorFactory.stop(Source)

confluent

public static <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:

CoreOperatorFactory.confluent(Source, Source)

confluent

public static <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:

CoreOperatorFactory.confluent(Source, Source, Source)

confluent

public static <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:

CoreOperatorFactory.confluent(Source, Source, Source, Source)

confluent

public static <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:

CoreOperatorFactory.confluent(Iterable)

confluent

@SafeVarargs
public static <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:

CoreOperatorFactory.confluent(Iterable)

checkpoint

public static <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.

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:

CoreOperatorFactory.checkpoint(Source)

project

public static <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 some parameters were null

See Also:

CoreOperatorFactory.project(Source, Class)

project

public static 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:

CoreOperatorFactory.project(Source)

extend

public static <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

See Also:

CoreOperatorFactory.extend(Source, Class)

extend

public static 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:

CoreOperatorFactory.extend(Source)

restructure

public static <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

See Also:

CoreOperatorFactory.restructure(Source, Class)

restructure

public static 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:

CoreOperatorFactory.restructure(Source)