com.asakusafw.vocabulary.batch

Class BatchDescription

java.lang.Object

com.asakusafw.vocabulary.batch.BatchDescription

public abstract class BatchDescription
extends Object

An abstract super class for describing the details of a batch workflow. Subclasses must override describe() method and build a workflow in the method, like as following:

@Batch(name = "hoge")
public class HogeBatch extends BatchDescription {
    @Override
    public void describe() {
        Work first = run(FirstFlow.class).soon();
        Work second = run(SecondFlow.class).after(first);
        Work para = run(ParallelFlow.class).after(first);
        Work join = run(JoinFlow.class).after(second, para);
        ...
    }
}

In the above example, only FirstFlow will be started first. And then, after the FirstFlow was completed, SecondFlow and ParallelFlow will be concurrently processed. Finally, JoinFlow was processed after the all other jobflows were completed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BatchDescription.DependencyBuilder A builder for building batch by specifying Unit-of-Works and their dependencies.

Constructor Summary

Constructors

Constructor and Description
BatchDescription()

Method Summary

Modifier and Type	Method and Description
protected abstract void	describe() Describes workflow structure.
Collection<Work>	getWorks() Returns a collection of Unit-of-Works which is represented in this batch.
protected BatchDescription.DependencyBuilder	run(Class<? extends FlowDescription> jobflow) Start registering a new jobflow to this batch.
protected BatchDescription.DependencyBuilder	run(String scriptDefinition) Deprecated. does not supported
void	start() Analyzes batch DSL using batch description method.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchDescription

public BatchDescription()

Method Detail

start

public final void start()

Analyzes batch DSL using batch description method. Application developers should not invoke this method directly.

describe

protected abstract void describe()

Describes workflow structure. Subclasses must override this method and build a workflow using Asakusa batch DSL.

run

@Deprecated
protected BatchDescription.DependencyBuilder run(String scriptDefinition)

Deprecated. does not supported

Start registering a new script job to this batch.

Parameters:

scriptDefinition - the script definition path

Returns:

a builder for specifying dependencies of the adding job

Throws:

IllegalArgumentException - if the script definition is something wrong

IllegalStateException - if another job is building dependencies

run

protected BatchDescription.DependencyBuilder run(Class<? extends FlowDescription> jobflow)

Start registering a new jobflow to this batch. Clients must tell the dependencies of the target jobflow to the resulting builder of this method, by using either methods.

• run(...).soon()
• run(...).after(...)

The both above methods will return a Work object which represents the registered jobflow. And then the latter method accepts Work objects as its dependencies.

Parameters:

jobflow - the target jobflow class

Returns:

a builder for specifying dependencies of the adding job

Throws:

IllegalArgumentException - if the jobflow class is something wrong

IllegalStateException - if another job is building dependencies

getWorks

public Collection<Work> getWorks()

Returns a collection of Unit-of-Works which is represented in this batch.

Returns:

a collection of Unit-of-Works of this batch

toString

public String toString()

Overrides:

toString in class Object