org.apache.flink.runtime.executiongraph

Class ExecutionGraphIterator

java.lang.Object

org.apache.flink.runtime.executiongraph.ExecutionGraphIterator

All Implemented Interfaces:

Iterator<ExecutionVertex>

public class ExecutionGraphIterator
extends Object
implements Iterator<ExecutionVertex>

This class provides an implementation of the Iterator interface which allows to traverse an execution graph and visit every reachable vertex exactly once. The order in which the vertices are visited corresponds to the order of their discovery in a depth first search.

This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
ExecutionGraphIterator(ExecutionGraph executionGraph, boolean forward) Creates a new execution graph iterator.
ExecutionGraphIterator(ExecutionGraph executionGraph, ExecutionVertex startVertex, boolean forward) Creates a new execution graph iterator.
ExecutionGraphIterator(ExecutionGraph executionGraph, int startStage, boolean confinedToStage, boolean forward) Creates a new execution graph iterator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext()
ExecutionVertex	next()
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionGraphIterator

public ExecutionGraphIterator(ExecutionGraph executionGraph,
                      boolean forward)

Creates a new execution graph iterator.

Parameters:

executionGraph - the execution graph that should be traversed

forward - true if the graph should be traversed in correct order, false to traverse it in reverse order

ExecutionGraphIterator

public ExecutionGraphIterator(ExecutionGraph executionGraph,
                      int startStage,
                      boolean confinedToStage,
                      boolean forward)

Creates a new execution graph iterator.

Parameters:

executionGraph - the execution graph that should be traversed

startStage - the index of the stage of the graph where the traversal is supposed to begin

confinedToStage - false if the graph iterator is allowed to traverse to upper (in case of reverse order traversal lower) stages, true otherwise.

forward - true if the graph should be traversed in correct order, false to traverse it in reverse order

ExecutionGraphIterator

public ExecutionGraphIterator(ExecutionGraph executionGraph,
                      ExecutionVertex startVertex,
                      boolean forward)

Creates a new execution graph iterator. This constructor can be used to traverse only specific parts of the graph starting at startVertex. The iterator will not switch to the next input/output vertex of an output/input vertex has been reached.

Parameters:

executionGraph - the execution graph that should be traversed

startVertex - the vertex to start the traversal from

forward - true if the graph should be traversed in correct order, false to reverse it in reverse order

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<ExecutionVertex>

next

public ExecutionVertex next()

Specified by:

next in interface Iterator<ExecutionVertex>

remove

public void remove()

Specified by:

remove in interface Iterator<ExecutionVertex>