org.dapper.server.flow

Class Flow

java.lang.Object

org.dapper.server.flow.Flow

All Implemented Interfaces:

Cloneable, Taggable<Object>, Renderable, org.shared.event.EnumStatus<FlowStatus>

public class Flow
extends Object
implements Cloneable, Renderable, org.shared.event.EnumStatus<FlowStatus>, Taggable<Object>

A class for storing the flow computation state.

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<FlowEdge>	emptyList An empty FlowEdge list.
protected CountDown<LogicalNode>	flowCountDown The CountDown on LogicalNodes.
protected static ThreadLocal<Map<FlowNode,FlowNode>>	nodeMapLocal A temporary mapping of FlowNode proxies to actuals local to the current thread.

Constructor Summary

Constructors

Constructor and Description
Flow(String name, ClassLoader cl) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
FlowNode	add(FlowNode node, FlowEdge... edgeDeps) Adds a FlowNode along with FlowEdge dependencies.
<T extends FlowEdge> T	add(T edge) Adds a FlowEdge and checks for cycles that may arise.
protected static <V extends org.shared.parallel.Traversable<V,E>,E extends org.shared.parallel.Edge<V>> void	assignNodeNeighbors(Map<V,V> nodeMap, Map<E,E> edgeMap) Rebuilds edge incidence relationships on a flow copy.
void	build(Object... args) Builds this flow using the given FlowBuilder.
Flow	clone() Copies this flow.
protected CountDown<LogicalNode>	createFlowCountDown(Set<LogicalNode> cds) Creates the flow CountDown.
protected void	embedSubflows(Object[] args) Embeds subflows.
Object	getAttachment() Gets the attachment.
CountDown<LogicalNode>	getFlowCountDown() Gets the flow CountDown.
Set<LogicalNode>	getNodes() Gets the LogicalNodes.
FlowStatus	getStatus()
void	render(Formatter f) Renders this object to the given Formatter.
Flow	setAttachment(Object attachment) Sets the attachment.
void	setStatus(FlowStatus status)
String	toString() Gets the name of this flow.

Methods inherited from class java.lang.Object

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

Field Detail

nodeMapLocal

protected static final ThreadLocal<Map<FlowNode,FlowNode>> nodeMapLocal

A temporary mapping of FlowNode proxies to actuals local to the current thread.

emptyList

protected static final List<FlowEdge> emptyList

An empty FlowEdge list.

flowCountDown

protected CountDown<LogicalNode> flowCountDown

The CountDown on LogicalNodes.

Constructor Detail

Flow

public Flow(String name,
    ClassLoader cl)

Default constructor.

Method Detail

add

public FlowNode add(FlowNode node,
           FlowEdge... edgeDeps)

Adds a FlowNode along with FlowEdge dependencies.

add

public <T extends FlowEdge> T add(T edge)

Adds a FlowEdge and checks for cycles that may arise.

createFlowCountDown

protected CountDown<LogicalNode> createFlowCountDown(Set<LogicalNode> cds)

Creates the flow CountDown.

clone

public Flow clone()

Copies this flow.

Overrides:

clone in class Object

assignNodeNeighbors

protected static final <V extends org.shared.parallel.Traversable<V,E>,E extends org.shared.parallel.Edge<V>> void assignNodeNeighbors(Map<V,V> nodeMap,
                                                                                                              Map<E,E> edgeMap)

Rebuilds edge incidence relationships on a flow copy.

toString

public String toString()

Gets the name of this flow.

Overrides:

toString in class Object

getStatus

public FlowStatus getStatus()

Specified by:

getStatus in interface org.shared.event.EnumStatus<FlowStatus>

setStatus

public void setStatus(FlowStatus status)

Specified by:

setStatus in interface org.shared.event.EnumStatus<FlowStatus>

getAttachment

public Object getAttachment()

Description copied from interface: Taggable

Gets the attachment.

Specified by:

getAttachment in interface Taggable<Object>

setAttachment

public Flow setAttachment(Object attachment)

Description copied from interface: Taggable

Sets the attachment.

Specified by:

setAttachment in interface Taggable<Object>

getNodes

public Set<LogicalNode> getNodes()

Gets the LogicalNodes.

getFlowCountDown

public CountDown<LogicalNode> getFlowCountDown()

Gets the flow CountDown.

build

public void build(Object... args)
           throws DapperException

Builds this flow using the given FlowBuilder.

Throws:

DapperException - when something goes awry.

embedSubflows

protected void embedSubflows(Object[] args)

Embeds subflows.

render

public void render(Formatter f)

Description copied from interface: Renderable

Renders this object to the given Formatter.

Specified by:

render in interface Renderable