GraphWrapper

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> phoenixst >> [ plexus overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.phoenixst.plexus.GraphWrapper

SOURCE |

Download com.phoenixst.plexus.GraphWrapper

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.phoenixst.plexus
Class GraphWrapper

java.lang.Object
  com.phoenixst.plexus.GraphWrapper

All Implemented Interfaces:: Graph, java.io.Serializable

Direct Known Subclasses:: GraphTransformer, GraphUtils.SynchronizedGraphWrapper, GraphUtils.UnmodifiableGraphWrapper, ObservableGraphWrapper

public class GraphWrapper
extends java.lang.Object
implements Graph, java.io.Serializable

A Graph which wraps another. This class is intended to be extended.

Since:: 1.0
Version:: $Revision: 1.12 $

Nested Class Summary

protected class GraphWrapper.EdgeIteratorWrapper
          Protected edge iterator implementation.

protected class GraphWrapper.EdgeWrapper
          Edge wrapper.

protected class GraphWrapper.NodeIteratorWrapper
          Protected node iterator implementation.

protected class GraphWrapper.TraverserWrapper
          Protected implementation of Traverser.

Nested classes inherited from class com.phoenixst.plexus.Graph

Graph.Edge

Field Summary

protected Graph g
          The wrapped graph.

Constructor Summary

GraphWrapper(Graph g)
          Creates a new GraphWrapper.

Method Summary

Graph.Edge addEdge(java.lang.Object object, java.lang.Object tail, java.lang.Object head)
          Adds the specified edge to the Graph (optional operation).

boolean addNode(java.lang.Object node)
          Adds node to this Graph (optional operation).

void clear()
          Removes all nodes and edges from this Graph (optional operation).

boolean containsEdge(Graph.Edge edge)
          Returns true if this Graph contains the specified Edge.

boolean containsNode(java.lang.Object node)
          Returns true if this Graph contains the specified node.

int degree(java.lang.Object node)
          Returns the degree of node, defined as the number of edges incident on node, with self-loops counted twice.

java.util.Iterator edgeIterator()
          Returns an Iterator over all the Edges in this Graph.

java.util.Iterator edgeIterator(java.lang.Object tail, java.lang.Object head)
          Returns an Iterator over all Edges from this Graph with the specified tail and head.

int edgeSize()
          Returns the number of edges in this Graph.

Graph.Edge getEdge(java.lang.Object tail, java.lang.Object head)
          Returns an Edge from this Graph with the specified tail and head, or null if it does not exist.

int inDegree(java.lang.Object node)
          If this is a directed graph, returns the in degree of node, defined as the number of edges entering node.

Traverser inTraverser(java.lang.Object node)
          If this is a directed graph, returns a Traverser from node to all adjacent nodes reachable through edges whose head is the given node.

boolean isDirected()
          Returns whether or not this Graph is directed.

boolean isEmpty()
          Returns true if this Graph contains no edges, it may contain nodes.

boolean isSimple()
          Returns whether or not this Graph is simple.

java.util.Iterator nodeIterator()
          Returns an Iterator over all the nodes in this Graph.

int nodeSize()
          Returns the number of nodes in this Graph.

int outDegree(java.lang.Object node)
          If this is a directed graph, returns the out degree of node, defined as the number of edges leaving node.

Traverser outTraverser(java.lang.Object node)
          If this is a directed graph, returns a Traverser from node to all adjacent nodes reachable through edges whose tail is the given node.

boolean removeEdge(Graph.Edge edge)
          Removes the specified Edge from this Graph (optional operation).

boolean removeNode(java.lang.Object node)
          Removes node from this Graph (optional operation).

Traverser traverser(java.lang.Object node)
          Returns a Traverser from node to all adjacent nodes.

protected Graph.Edge unwrapEdge(Graph.Edge edge)
          Returns an unwrapped Edge, or null if the edge didn't come from this graph.

protected java.lang.Object unwrapEdgeObject(java.lang.Object edgeObject)
          Returns an unwrapped edge Object.

protected java.lang.Object unwrapNode(java.lang.Object node)
          Returns an unwrapped node.

protected GraphWrapper.EdgeWrapper wrapEdge(Graph.Edge edge)
          Returns a wrapped Edge.

protected java.util.Iterator wrapEdgeIterator(java.util.Iterator edgeIter)
          Returns a wrapped edge iterator.

protected java.lang.Object wrapEdgeObject(java.lang.Object edgeObject)
          Returns a wrapped edge Object.

protected java.lang.Object wrapNode(java.lang.Object node)
          Returns a wrapped node.

protected java.util.Iterator wrapNodeIterator(java.util.Iterator nodeIter)
          Returns a wrapped node iterator.

protected Traverser wrapTraverser(Traverser traverser)
          Returns a wrapped traverser.

Methods inherited from class java.lang.Object

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

Field Detail

g

protected Graph g

The wrapped graph.

Constructor Detail

GraphWrapper

public GraphWrapper(Graph g)

Creates a new GraphWrapper.

Method Detail

wrapNode

protected java.lang.Object wrapNode(java.lang.Object node)

Returns a wrapped node. If the argument node is an Edge produced by the wrapped graph, then it wraps it as an Edge.

unwrapNode

protected java.lang.Object unwrapNode(java.lang.Object node)

Returns an unwrapped node. If the argument node is an Edge produced by this graph, then it returns the unwrapped Edge.

wrapEdgeObject

protected java.lang.Object wrapEdgeObject(java.lang.Object edgeObject)

Returns a wrapped edge Object.

unwrapEdgeObject

protected java.lang.Object unwrapEdgeObject(java.lang.Object edgeObject)

Returns an unwrapped edge Object.

wrapEdge

protected GraphWrapper.EdgeWrapper wrapEdge(Graph.Edge edge)

Returns a wrapped Edge.

unwrapEdge

protected Graph.Edge unwrapEdge(Graph.Edge edge)

Returns an unwrapped Edge, or null if the edge didn't come from this graph.

wrapNodeIterator

protected java.util.Iterator wrapNodeIterator(java.util.Iterator nodeIter)

Returns a wrapped node iterator.

wrapEdgeIterator

protected java.util.Iterator wrapEdgeIterator(java.util.Iterator edgeIter)

Returns a wrapped edge iterator.

wrapTraverser

protected Traverser wrapTraverser(Traverser traverser)

Returns a wrapped traverser.