com.asakusafw.vocabulary.iterative

Annotation Type Iterative

@Target(value={PARAMETER,METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Documented
public @interface Iterative

An annotation for iterative elements. Iterative elements must be an external input or user defined operator.

iterative external input

To make an external input iterative, put an @Iterative before @Import.

// external inputs
@IterativeBatch(name = ...)
public class Something extends FlowDescription {
    ...
    public Something(
            @Iterative(...) @Import(...) In<...> input,
            ...) {
        ...
    }
    ...
}

iterative user operator

If iterative parameters are used in a user defined operator, put an @Iterative before its operator annotation.

// operators
public abstract class Something {
    ...
    @Iterative(...)
    @SomeOperator
    public void something(...) {
        ... BatchContext.get("some-iterative-parameter") ...
    }
    ...
}

iteration scope

If @Iterative has iterative parameter names, the annotated element will be considered as a scoped iterative element. It sometimes has advantages for scope-less iterative elements: re-evaluating the target element will be reduced (optional operation).

Since:

0.8.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	value The iterative parameter names.

Element Detail

value

public abstract String[] value

The iterative parameter names. If this is empty, the target element always re-evaluates for each iteration.

Default:

{}