org.springframework.cloud.dataflow.core.dsl

Class FlowNode

java.lang.Object

org.springframework.cloud.dataflow.core.dsl.AstNode

org.springframework.cloud.dataflow.core.dsl.LabelledTaskNode

org.springframework.cloud.dataflow.core.dsl.FlowNode

public class FlowNode
extends LabelledTaskNode

The AST node representing a flow. A flow is a series of things to execute sequentially. Those things can themselves be individual task applications or splits. In DSL form a flow is expressed like this:

 
 aa && bb
 
 

Author:

Andy Clement

Field Summary

Fields inherited from class org.springframework.cloud.dataflow.core.dsl.AstNode

endPos, startPos

Method Summary

Modifier and Type	Method and Description
void	accept(TaskVisitor visitor)
List<LabelledTaskNode>	getSeries() For nodes representing a flow or a split, return the series of elements to run in sequence/parallel.
LabelledTaskNode	getSeriesElement(int index) For nodes representing a flow or a split, return a specific element in the series of things that will run either sequentially or in parallel.
int	getSeriesLength() For nodes representing a flow or split, return how many are in the series of things to run (so the number to run in sequence or the number to run in parallel).
boolean	isFlow()
String	stringify(boolean includePositionInfo)
String	toString()

Methods inherited from class org.springframework.cloud.dataflow.core.dsl.LabelledTaskNode

getLabel, getLabelString, hasLabel, isSplit, isTaskApp, setLabel

Methods inherited from class org.springframework.cloud.dataflow.core.dsl.AstNode

getEndPos, getStartPos, stringify

Methods inherited from class java.lang.Object

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

Method Detail

stringify

public String stringify(boolean includePositionInfo)

Specified by:

stringify in class AstNode

Parameters:

includePositionInfo - position information is returned as a part of the result if set to true.

Returns:

a string representation of the AST. Useful for debugging/testing.

getSeriesLength

public int getSeriesLength()

Description copied from class: LabelledTaskNode

For nodes representing a flow or split, return how many are in the series of things to run (so the number to run in sequence or the number to run in parallel).

Overrides:

getSeriesLength in class LabelledTaskNode

Returns:

the length of the series for flow or split nodes, otherwise -1

getSeries

public List<LabelledTaskNode> getSeries()

Description copied from class: LabelledTaskNode

For nodes representing a flow or a split, return the series of elements to run in sequence/parallel.

Overrides:

getSeries in class LabelledTaskNode

Returns:

the series of elements for this flow/split, or null if not a flow/split node

getSeriesElement

public LabelledTaskNode getSeriesElement(int index)

Description copied from class: LabelledTaskNode

For nodes representing a flow or a split, return a specific element in the series of things that will run either sequentially or in parallel.

Overrides:

getSeriesElement in class LabelledTaskNode

Parameters:

index - the element of interest

Returns:

the indicated series or null if this is not a flow/split node

isFlow

public boolean isFlow()

Overrides:

isFlow in class LabelledTaskNode

Returns:

true if this node represents a flow (a number of jobs to run in sequence)

toString

public String toString()

Overrides:

toString in class Object

accept

public void accept(TaskVisitor visitor)

Specified by:

accept in class LabelledTaskNode