infovis.graph
Class GraphProxy

java.lang.Object
  infovis.graph.GraphProxy

All Implemented Interfaces:

Graph, Metadata, Constants

Direct Known Subclasses:

AbstractGraphLayout

public class GraphProxy
extends Object
implements Graph

Class GraphProxy

Version:

$Revision: 1.13 $

Author:

Jean-Daniel Fekete

Field Summary

Fields inherited from interface infovis.Graph

GRAPH_TYPE, GRAPH_TYPE_DIRECTED, GRAPH_TYPE_UNDIRECTED, NIL

Fields inherited from interface infovis.metadata.Constants

CONTRIBUTOR, COVERAGE, CREATOR, DATE, DESCRITION, FORMAT, IDENTIFIER, LANGUAGE, PUBLISHER, RELATION, RIGHTS, SOURCE, SUBJECT, TITLE, TYPE

Constructor Summary

GraphProxy(Graph graph)

Method Summary

int	addEdge(int v1, int v2) Adds a new edge between two vertices.
void	addGraphChangedListener(GraphChangedListener l) Attaches a GraphChangedListener to the graph.
int	addVertex() Adds a new "in" vertex to the graph.
void	clear() Clears the Graph.
RowIterator	edgeIterator() Returns an iterator over the edges of the graph.
RowIterator	edgeIterator(int vertex) Returns an iterator over all the edges (incoming and outgoing) of a specified vertex.
int	findEdge(int v1, int v2) Returns an edge between two specified vertices.
MutableAttributeSet	getClientProperty() Returns a MutableAttributeSet associating keys to values holding user-supplied data.
int	getDegree(int vertex) Returns the degree of the vertex, which is inDegree + outDegree.
int	getEdge(int v1, int v2) Returns an edge between two specified vertices.
int	getEdgesCount() Returns the number of edges in the graph.
DynamicTable	getEdgeTable() Returns the edgeTable.
int	getFirstVertex(int edge) Returns the first vertex of the specified edge.
Graph	getGraph()
int	getInDegree(int vertex) Returns the in degree of the vertex, which is simply the number of incoming edges at the vertex.
int	getInEdgeAt(int vertex, int index) Returns the incoming edge of a specified vertrex at a specified index.
MutableAttributeSet	getMetadata() Returns the MutableAttributeSet associating keys to values for qualifying the data contained in the instance of this interface.
String	getName() Returns the Graph name.
int	getOtherVertex(int edge, int vertex) Given a specified edge and a vertex on one side of this edge, returns the vertex on the other side.
int	getOutDegree(int vertex) Returns the out degree of the vertex, which is simply the number of outgoing edges of the vertex.
int	getOutEdgeAt(int vertex, int index) Returns the outgoing edge of a specified vertex at a specified index.
int	getSecondVertex(int edge) Returns the second vertex of an edge.
DynamicTable	getVertexTable() Returns the vertex Table.
int	getVerticesCount() Returns the number of vertices in the graph.
RowIterator	inEdgeIterator(int vertex) Returns an iterator over the incoming edges of specified vertex.
boolean	isDirected() Returns true if the graph is directed.
RowIterator	outEdgeIterator(int vertex) Returns an iterator over the outgoing edges of a specified vertex.
void	removeEdge(int edge) Removes the specified edge.
void	removeGraphChangedListener(GraphChangedListener l) Removes a GraphChangedListener from the graph.
void	removeVertex(int vertex) Removes the specified vertex from the graph.
void	setDirected(boolean directed) Sets the graph to directed or undirected.
void	setGraph(Graph graph)
void	setName(String name) Sets the Graph name.
RowIterator	vertexIterator() Returns an iterator over the vertices of the graph.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphProxy

public GraphProxy(Graph graph)

Method Detail

setGraph

public void setGraph(Graph graph)

getGraph

public Graph getGraph()

getName

public String getName()

Description copied from interface: Graph

Returns the Graph name.

Specified by:

getName in interface Graph

Returns:

the Graph name.

setName

public void setName(String name)

Description copied from interface: Graph

Sets the Graph name.

Specified by:

setName in interface Graph

Parameters:

name - The Graph name to set

clear

public void clear()

Description copied from interface: Graph

Clears the Graph.

After this method, the graph tables are almost in the same state as if it had been created afresh except it contains the same columns as before but they are all cleared.

Specified by:

clear in interface Graph

getClientProperty

public MutableAttributeSet getClientProperty()

Description copied from interface: Metadata

Returns a MutableAttributeSet associating keys to values holding user-supplied data.

Specified by:

getClientProperty in interface Metadata

Returns:

an AttributeSet holding user-supplied keys/values.

getMetadata

public MutableAttributeSet getMetadata()

Description copied from interface: Metadata

Returns the MutableAttributeSet associating keys to values for qualifying the data contained in the instance of this interface.

Specified by:

getMetadata in interface Metadata

Returns:

the AttributeSet associating metadate keys to values.

addEdge

public int addEdge(int v1,
                   int v2)

Description copied from interface: Graph

Adds a new edge between two vertices.

Specified by:

addEdge in interface Graph

Parameters:

v1 - the first vertex.

v2 - the second vertex.

Returns:

the new edge index.

addGraphChangedListener

public void addGraphChangedListener(GraphChangedListener l)

Description copied from interface: Graph

Attaches a GraphChangedListener to the graph.

Specified by:

addGraphChangedListener in interface Graph

Parameters:

l - the GraphChangedListener to notify when the graph structure changes.

addVertex

public int addVertex()

Description copied from interface: Graph

Adds a new "in" vertex to the graph.

Specified by:

addVertex in interface Graph

Returns:

the "in" vertex number.

edgeIterator

public RowIterator edgeIterator()

Description copied from interface: Graph

Returns an iterator over the edges of the graph.

Specified by:

edgeIterator in interface Graph

Returns:

an iterator over the edges of the graph

edgeIterator

public RowIterator edgeIterator(int vertex)

Description copied from interface: Graph

Returns an iterator over all the edges (incoming and outgoing) of a specified vertex.

Specified by:

edgeIterator in interface Graph

Parameters:

vertex - the vertex.

Returns:

the iterator over all the edges of the vertex.

outEdgeIterator

public RowIterator outEdgeIterator(int vertex)

Description copied from interface: Graph

Returns an iterator over the outgoing edges of a specified vertex.

Specified by:

outEdgeIterator in interface Graph

Parameters:

vertex - the vertex.

Returns:

the iterator over the outgoing edges of the vertex.

findEdge

public int findEdge(int v1,
                    int v2)

Description copied from interface: Graph

Returns an edge between two specified vertices.

Specified by:

findEdge in interface Graph

Parameters:

v1 - the first vertex.

v2 - the second vertex.

Returns:

an edge between two specified vertices creating one if none exists.

getOutDegree

public int getOutDegree(int vertex)

Description copied from interface: Graph

Returns the out degree of the vertex, which is simply the number of outgoing edges of the vertex.

Specified by:

getOutDegree in interface Graph

Parameters:

vertex - the vertex.

Returns:

The out degree of the vertex.

getDegree

public int getDegree(int vertex)

Description copied from interface: Graph

Returns the degree of the vertex, which is inDegree + outDegree.

Specified by:

getDegree in interface Graph

Parameters:

vertex - the vertex.

Returns:

The degree of the vertex.

getEdge

public int getEdge(int v1,
                   int v2)

Description copied from interface: Graph

Returns an edge between two specified vertices.

Specified by:

getEdge in interface Graph

Parameters:

v1 - the first vertex.

v2 - the second vertex.

Returns:

an edge between two specified vertices or NIL if none exists.

getOutEdgeAt

public int getOutEdgeAt(int vertex,
                        int index)

Description copied from interface: Graph

Returns the outgoing edge of a specified vertex at a specified index.

Specified by:

getOutEdgeAt in interface Graph

Parameters:

vertex - the in vertex of the requested edge

index - the index of the edge in the edge list of the vertex

Returns:

the outgoing edge of a specified vertex at a specified index or NIL.

getEdgesCount

public int getEdgesCount()

Description copied from interface: Graph

Returns the number of edges in the graph.

Specified by:

getEdgesCount in interface Graph

Returns:

the number of edges in the graph.

getEdgeTable

public DynamicTable getEdgeTable()

Description copied from interface: Graph

Returns the edgeTable.

Specified by:

getEdgeTable in interface Graph

Returns:

DefaultTable

getInDegree

public int getInDegree(int vertex)

Description copied from interface: Graph

Returns the in degree of the vertex, which is simply the number of incoming edges at the vertex.

Specified by:

getInDegree in interface Graph

Parameters:

vertex - the vertex.

Returns:

The number of incoming edges at this vertex.

getInEdgeAt

public int getInEdgeAt(int vertex,
                       int index)

Description copied from interface: Graph

Returns the incoming edge of a specified vertrex at a specified index.

Specified by:

getInEdgeAt in interface Graph

Parameters:

vertex - the out vertex of the requested edge

index - the index of the edge in the edge list of the vertex

Returns:

the incoming edge of a specified vertex at a specified index or NIL.

getFirstVertex

public int getFirstVertex(int edge)

Description copied from interface: Graph

Returns the first vertex of the specified edge. When the graph is directed, this is the source vertex.

Specified by:

getFirstVertex in interface Graph

Parameters:

edge - the edge.

Returns:

the first vertex of an edge or NIL.

getSecondVertex

public int getSecondVertex(int edge)

Description copied from interface: Graph

Returns the second vertex of an edge. When the graph is directed, this is the destination/target vertex.

Specified by:

getSecondVertex in interface Graph

Parameters:

edge - the edge.

Returns:

the second vertex of the edge.

getOtherVertex

public int getOtherVertex(int edge,
                          int vertex)

Description copied from interface: Graph

Given a specified edge and a vertex on one side of this edge, returns the vertex on the other side. If the specified vertex is the first vertex, it returns the second and vice versa.

Specified by:

getOtherVertex in interface Graph

Parameters:

edge - the edge

vertex - the vertex

Returns:

the other vertex or NIL if the vertex is not on any side of the edge.

getVertexTable

public DynamicTable getVertexTable()

Description copied from interface: Graph

Returns the vertex Table.

Specified by:

getVertexTable in interface Graph

Returns:

the vertex Table

getVerticesCount

public int getVerticesCount()

Description copied from interface: Graph

Returns the number of vertices in the graph.

Specified by:

getVerticesCount in interface Graph

Returns:

The number of vertices in the graph.

inEdgeIterator

public RowIterator inEdgeIterator(int vertex)

Description copied from interface: Graph

Returns an iterator over the incoming edges of specified vertex.

Specified by:

inEdgeIterator in interface Graph

Parameters:

vertex - the vertex

Returns:

an iterator over the incoming edges of the specified vertex

isDirected

public boolean isDirected()

Description copied from interface: Graph

Returns true if the graph is directed.

Specified by:

isDirected in interface Graph

Returns:

true if the graph is directed.

removeEdge

public void removeEdge(int edge)

Description copied from interface: Graph

Removes the specified edge.

Specified by:

removeEdge in interface Graph

Parameters:

edge - the edge to remove

removeGraphChangedListener

public void removeGraphChangedListener(GraphChangedListener l)

Description copied from interface: Graph

Removes a GraphChangedListener from the graph.

Specified by:

removeGraphChangedListener in interface Graph

Parameters:

l - the GraphChangedListener to remove

removeVertex

public void removeVertex(int vertex)

Description copied from interface: Graph

Removes the specified vertex from the graph.

Specified by:

removeVertex in interface Graph

Parameters:

vertex - the vertex to remove

setDirected

public void setDirected(boolean directed)

Description copied from interface: Graph

Sets the graph to directed or undirected.

Specified by:

setDirected in interface Graph

Parameters:

directed - boolean specifying whether the graph is directed or not.

vertexIterator

public RowIterator vertexIterator()

Description copied from interface: Graph

Returns an iterator over the vertices of the graph.

Specified by:

vertexIterator in interface Graph

Returns:

an iterator over the vertices of the graph