net.automatalib.util.graphs.traversal

Interface GraphTraversalVisitor<N,E,D>

Type Parameters:

N - node class

E - edge class

D - user data class

All Known Implementing Classes:

DefaultGraphTraversalVisitor

public interface GraphTraversalVisitor<N,E,D>

Visitor interface for graph traversals.

This interface declares methods that are called upon basic graph traversal actions.

Author:

Malte Isberner

Method Summary

Methods

Modifier and Type	Method and Description
void	backtrackEdge(N srcNode, D srcData, E edge, N tgtNode, D tgtData)
void	finishExploration(N node, D inData) Called when the exploration of a node is finished.
GraphTraversalAction	processEdge(N srcNode, D srcData, E edge, N tgtNode, Holder<D> outData) Called when an edge is processed.
GraphTraversalAction	processInitial(N initialNode, Holder<D> outData) Called when a node is processed initially.
boolean	startExploration(N node, D data) Called when the exploration of a node is started.

Method Detail

processInitial

GraphTraversalAction processInitial(N initialNode,
                                  Holder<D> outData)

Called when a node is processed initially.

Parameters:

initialNode - the node that is processed

Returns:

the action to perform

startExploration

boolean startExploration(N node,
                       D data)

Called when the exploration of a node is started.

Parameters:

node - the node which's exploration is about to be started

data - the user data associated with this node

Returns:

the action to perform

finishExploration

void finishExploration(N node,
                     D inData)

Called when the exploration of a node is finished.

Parameters:

node - the node which's exploration is being finished

data - the user data associated with this node

processEdge

GraphTraversalAction processEdge(N srcNode,
                               D srcData,
                               E edge,
                               N tgtNode,
                               Holder<D> outData)

Called when an edge is processed.

Parameters:

srcNode - the source node

srcData - the user data associated with the source node

edge - the edge that is being processed

Returns:

the action to perform

backtrackEdge

void backtrackEdge(N srcNode,
                 D srcData,
                 E edge,
                 N tgtNode,
                 D tgtData)