com.asakusafw.vocabulary.flow

Class FlowDescription

java.lang.Object

com.asakusafw.vocabulary.flow.FlowDescription

public abstract class FlowDescription
extends Object

An abstract super class for describing the details of a data-flow. Subclasses must override describe() method and build a data-flow in the method.

Constructor Summary

Constructors

Constructor and Description
FlowDescription()

Method Summary

Modifier and Type	Method and Description
protected abstract void	describe() Describes data-flow structure.
static String	getJobFlowName(Class<? extends FlowDescription> aClass) Returns the flow ID of the target jobflow class.
boolean	isFlowPart() Deprecated. Use isFlowPart(Class) instead
boolean	isFlowPart(Class<? extends FlowDescription> aClass) Returns whether the target class represents a flow-part or not.
boolean	isJobFlow() Deprecated. Use isJobFlow(Class) instead
static boolean	isJobFlow(Class<? extends FlowDescription> aClass) Returns whether the target class represents a jobflow or not.
void	start() Analyzes flow DSL using flow description method.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowDescription

public FlowDescription()

Method Detail

start

public final void start()

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

describe

protected abstract void describe()

Describes data-flow structure. Subclasses must override this method and build a data-flow using Asakusa flow DSL.

isJobFlow

@Deprecated
public boolean isJobFlow()

Deprecated. Use isJobFlow(Class) instead

Returns whether this object represents a jobflow or not.

Returns:

true if this represents a jobflow, otherwise false

isFlowPart

@Deprecated
public boolean isFlowPart()

Deprecated. Use isFlowPart(Class) instead

Returns whether this object represents a flow-part or not.

Returns:

true if this represents a flow-part, otherwise false

isJobFlow

public static boolean isJobFlow(Class<? extends FlowDescription> aClass)

Returns whether the target class represents a jobflow or not.

Parameters:

aClass - the target flow description class

Returns:

true if the class represents a jobflow, otherwise false

getJobFlowName

public static String getJobFlowName(Class<? extends FlowDescription> aClass)

Returns the flow ID of the target jobflow class.

Parameters:

aClass - the target flow description class

Returns:

the flow ID, or null if the target class is not a valid jobflow class

isFlowPart

public boolean isFlowPart(Class<? extends FlowDescription> aClass)

Returns whether the target class represents a flow-part or not.

Parameters:

aClass - the target flow description class

Returns:

true if the class represents a flow-part, otherwise false