org.eth.cyril.graphdrawing.graph.builder

Interface GraphBuilder

All Known Implementing Classes:

BasicGraphBuilder, CachedGraphBuilder

public interface GraphBuilder

A GraphBuilder is useful in building graphs from objects without having to manage the edges and nodes by oneself.

Method Summary

Modifier and Type	Method and Description
default void	buildEdge(java.lang.Object from, java.lang.Object to) Build a new edge between the two objects.
default void	buildEdge(java.lang.Object from, java.lang.Object to, double weight) Build a new edge between the two objects, associating it with a weight.
void	buildEdge(java.lang.Object from, java.lang.Object to, double weight, java.lang.Object value) Build a new edge between the two objects, assocating it with a weight and an object.
Graph	buildGraph() Build the graph with all its nodes and edges which were built.
default void	buildNode(java.lang.Object value) Build a node.
void	buildNode(java.lang.Object key, java.lang.Object value) Build a node.
static GraphBuilder	newBasicGraphBuilder() Returns a new basic graph builder.
static GraphBuilder	newCachedGraphBuilder() Returns a new cached graph builder.
void	startNewGraph() Tells the builder to start a new graph and therefore get rid of certain stored state.

Method Detail

newCachedGraphBuilder

static GraphBuilder newCachedGraphBuilder()

Returns a new cached graph builder. A cached graph builder remembers the built nodes over multiple graphs, even after startNewGraph() is called. Note that due to this, the startNewGraph() method will erase state of existing nodes, and should therefore not be used while the graph is still being used.

newBasicGraphBuilder

static GraphBuilder newBasicGraphBuilder()

Returns a new basic graph builder. A basic graph builder does not carry any state over from previous graphs to further graphs. Therefore also calling startNewGraph() is safe, as it won't erase any state from existing graphs.

startNewGraph

void startNewGraph()

Tells the builder to start a new graph and therefore get rid of certain stored state.

buildNode

void buildNode(java.lang.Object key,
               java.lang.Object value)

Build a node. The node will contain the given value as its Node.getValue(), and the key can be used to build edges with.

Parameters:

key - The key to associate the new node with within this builder, for building edges.

value - The value to use for the new node's value.

buildNode

default void buildNode(java.lang.Object value)

Build a node. This is equal to buildNode(value, value).

Parameters:

value - Both the key and the value, as in buildNode(value, value).

buildEdge

default void buildEdge(java.lang.Object from,
                       java.lang.Object to)

Build a new edge between the two objects. The objects must be already associated with nodes, and refer to the key passed to the buildNode(Object, Object) method or to the value passed to the buildNode(Object) method. If either or both of the nodes don't exist, the method will silently fail.

Parameters:

from - The object to build the edge from.

to - The object to build the edge to.

buildEdge

default void buildEdge(java.lang.Object from,
                       java.lang.Object to,
                       double weight)

Build a new edge between the two objects, associating it with a weight. See also buildEdge(Object, Object).

Parameters:

weight - The new weight of the edge.

buildEdge

void buildEdge(java.lang.Object from,
               java.lang.Object to,
               double weight,
               java.lang.Object value)

Build a new edge between the two objects, assocating it with a weight and an object. See also buildEdge(Object, Object).

Parameters:

weight - The new weight of the edge.

value - The value of the ddge, as in Edge.getValue().

buildGraph

Graph buildGraph()

Build the graph with all its nodes and edges which were built.

Returns:

The newly built graph.