edu.iu.dsc.tws.tset.graph

Interface MutableGraph<T>

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DAGMutableGraph

public interface MutableGraph<T>
extends java.io.Serializable

Graph used for modeling the TSet dependency structure

Method Summary

Modifier and Type	Method and Description
boolean	addNode(T node) Adds node if it is not already present.
default boolean	allowsSelfLoops() Returns true if this graph allows self-loops (edges that connect a node to itself).
T	getNodeById(java.lang.String id) returns the node which has the given Id or null if no such node exsists
boolean	isDirected() Returns true if the edges in this graph are directed.
java.util.Set<T>	nodes()
java.util.Set<T>	predecessors(T node) Returns all nodes in this graph adjacent to node which can be reached by traversing node's incoming edges against the direction (if any) of the edge.
boolean	putEdge(T orgin, T target) Adds an edge connecting nodeU to nodeV if one is not already present.
boolean	removeEdge(T nodeU, T nodeV) Removes the edge connecting nodeU to nodeV, if it is present.
boolean	removeNode(T node) Removes node if it is present; all edges incident to node will also be removed.
java.util.Set<T>	successors(T node) Returns all nodes in this graph adjacent to node which can be reached by traversing node's outgoing edges in the direction (if any) of the edge.

Method Detail

addNode

boolean addNode(T node)

Adds node if it is not already present.

Nodes must be unique, just as Map keys must be. They must also be non-null.

Returns:

true if the graph was modified as a result of this call

putEdge

boolean putEdge(T orgin,
                T target)

Adds an edge connecting nodeU to nodeV if one is not already present.

If the graph is directed, the resultant edge will be directed; otherwise, it will be undirected.

If nodeU and nodeV are not already present in this graph, this method will silently add nodeU and nodeV to the graph.

Returns:

true if the graph was modified as a result of this call

Throws:

java.lang.IllegalArgumentException - if the introduction of the edge would violate allowsSelfLoops()

nodes

java.util.Set<T> nodes()

removeNode

boolean removeNode(T node)

Removes node if it is present; all edges incident to node will also be removed.

Returns:

true if the graph was modified as a result of this call

removeEdge

boolean removeEdge(T nodeU,
                   T nodeV)

Removes the edge connecting nodeU to nodeV, if it is present.

Returns:

true if the graph was modified as a result of this call

successors

java.util.Set<T> successors(T node)

Returns all nodes in this graph adjacent to node which can be reached by traversing node's outgoing edges in the direction (if any) of the edge.

Throws:

java.lang.IllegalArgumentException - if node is not an element of this graph

predecessors

java.util.Set<T> predecessors(T node)

Returns all nodes in this graph adjacent to node which can be reached by traversing node's incoming edges against the direction (if any) of the edge.

Throws:

java.lang.IllegalArgumentException - if node is not an element of this graph

allowsSelfLoops

default boolean allowsSelfLoops()

Returns true if this graph allows self-loops (edges that connect a node to itself). Attempting to add a self-loop to a graph that does not allow them will throw an IllegalArgumentException.

isDirected

boolean isDirected()

Returns true if the edges in this graph are directed.

getNodeById

T getNodeById(java.lang.String id)

returns the node which has the given Id or null if no such node exsists

Parameters:

id - the id of the node to return