org.apache.flex.compiler.internal.graph

Interface IGraph<V,E extends IGraphEdge<V>>

Type Parameters:

V - Type of vertices in the graph.

E - Type of edges in the graph

All Known Implementing Classes:

Graph, SynchronizedGraph

public interface IGraph<V,E extends IGraphEdge<V>>

Interface to a generic graph. Vertices can be any old type of object. Edge's must implement IGraphEdge. There may only be a single directional edge from any vertex to any other vertex. For example, there can be an edge from A to B and another edge from B to A. However it is impossible to store a second edge from A to B.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addVertex(V vertex) Adds a vertex to the graph.
E	getEdge(V from, V to) Gets the edge in the graph that connects the two specified vertices.
Set<E>	getIncomingEdges(V vertex) Finds all the edges terminating at the specified vertex.
Set<E>	getOutgoingEdges(V vertex) Finds all the edges emanating from the specified vertex.
Set<V>	getVertices() Gets the set of all vertices in the graph.
E	removeEdge(E edge) Removes the specified edge or the edge in the graph that conects the same two vertices as the specified edge from the graph.
void	removeVertex(V vertex) Removes a vertex from the graph
E	setEdge(E edge) Set the edge between the vertex returned from IGraphEdge.getFrom() and the vertex returned from IGraphEdge.getTo().

Method Detail

addVertex

boolean addVertex(V vertex)

Adds a vertex to the graph.

Parameters:

vertex - Vertex to add

Returns:

true if vertex was added, and false if it already exists

removeVertex

void removeVertex(V vertex)

Removes a vertex from the graph

Parameters:

vertex - Vertex to remove.

setEdge

E setEdge(E edge)

Set the edge between the vertex returned from IGraphEdge.getFrom() and the vertex returned from IGraphEdge.getTo(). The the graph already contained an edge between those two vertices that edge is replaced with the specified edge and returned from this method.

Parameters:

edge - The new edge to add to the graph.

Returns:

null or the previous edge to connect the two vertices connected by the specified edge.

getEdge

E getEdge(V from,
        V to)

Gets the edge in the graph that connects the two specified vertices.

Parameters:

from -

to -

Returns:

null or the edge in the graph that connects to two specified vertices.

getOutgoingEdges

Set<E> getOutgoingEdges(V vertex)

Finds all the edges emanating from the specified vertex.

Returns:

Set of all edges emanating from the specified vertex.

getIncomingEdges

Set<E> getIncomingEdges(V vertex)

Finds all the edges terminating at the specified vertex.

Returns:

Set of all edges terminating at the specified vertex.

removeEdge

E removeEdge(E edge)

Removes the specified edge or the edge in the graph that conects the same two vertices as the specified edge from the graph.

Parameters:

edge - Edge to remove from the graph.

Returns:

The edge removed from the graph.

getVertices

Set<V> getVertices()

Gets the set of all vertices in the graph.

Returns:

Set of all vertices in the graph.