edu.uci.ics.jung.graph

Class AbstractTypedGraph<V,E>

java.lang.Object

edu.uci.ics.jung.graph.AbstractGraph<V,E>

edu.uci.ics.jung.graph.AbstractTypedGraph<V,E>

All Implemented Interfaces:

Graph<V,E>, Hypergraph<V,E>, java.io.Serializable

Direct Known Subclasses:

DirectedSparseGraph, DirectedSparseMultigraph, OrderedKAryTree, UndirectedSparseGraph, UndirectedSparseMultigraph

public abstract class AbstractTypedGraph<V,E>
extends AbstractGraph<V,E>

An abstract class for graphs whose edges all have the same EdgeType. Intended to simplify the implementation of such graph classes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected EdgeType	edgeType The edge type for all edges in this graph.

Constructor Summary

Constructors

Constructor and Description
AbstractTypedGraph(EdgeType edgeType) Creates an instance with the specified edge type.

Method Summary

Modifier and Type	Method and Description
EdgeType	getDefaultEdgeType() Returns this graph's edge type.
int	getEdgeCount(EdgeType edgeType) Returns the edge count for this graph if edge_type matches the edge type for this graph, and 0 otherwise.
java.util.Collection<E>	getEdges(EdgeType edgeType) Returns the edge set for this graph if edgeType matches the edge type for this graph, and an empty set otherwise.
EdgeType	getEdgeType(E e) Returns this graph's edge type, or null if e is not in this graph.
protected boolean	hasEqualEdgeType(EdgeType edgeType) Returns true if edge_type matches the default edge type for this graph, and false otherwise.
protected void	validateEdgeType(EdgeType edgeType) Throws an IllegalArgumentException if edge_type does not match the default edge type for this graph.

Methods inherited from class edu.uci.ics.jung.graph.AbstractGraph

addEdge, addEdge, addEdgeWithEndPoints, addEdgeWithEndpoints, addEdgeWithVertices, addEdgeWithVertices, degree, findEdge, findEdgeSet, getIncidentCount, getIncidentVertices, getNeighborCount, getOpposite, getPredecessorCount, getSuccessorCount, getValidatedEndpoints, inDegree, isIncident, isNeighbor, isPredecessor, isSuccessor, outDegree

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.uci.ics.jung.graph.Graph

getDest, getEndpoints, getInEdges, getOutEdges, getPredecessors, getSource, getSuccessors, isDest, isSource

Methods inherited from interface edu.uci.ics.jung.graph.Hypergraph

addVertex, containsEdge, containsVertex, getEdgeCount, getEdgesView, getIncidentEdges, getNeighbors, getVertexCount, getVerticesView, removeEdge, removeVertex

Field Detail

edgeType

protected final EdgeType edgeType

The edge type for all edges in this graph.

Constructor Detail

AbstractTypedGraph

public AbstractTypedGraph(EdgeType edgeType)

Creates an instance with the specified edge type.

Parameters:

edgeType - the type of edges that this graph accepts

Method Detail

getDefaultEdgeType

public EdgeType getDefaultEdgeType()

Returns this graph's edge type.

Returns:

the default edge type for this graph

getEdgeType

public EdgeType getEdgeType(E e)

Returns this graph's edge type, or null if e is not in this graph.

Returns:

the EdgeType of edge, or null if edge has no defined type

getEdges

public java.util.Collection<E> getEdges(EdgeType edgeType)

Returns the edge set for this graph if edgeType matches the edge type for this graph, and an empty set otherwise.

Parameters:

edgeType - the type of edges to be returned

Returns:

the collection of edges which are of type edge_type, or null if the graph does not accept edges of this type

See Also:

EdgeType

getEdgeCount

public int getEdgeCount(EdgeType edgeType)

Returns the edge count for this graph if edge_type matches the edge type for this graph, and 0 otherwise.

Parameters:

edgeType - the type of edge for which the count is to be returned

Returns:

the number of edges of type edge_type in this graph

hasEqualEdgeType

protected boolean hasEqualEdgeType(EdgeType edgeType)

Returns true if edge_type matches the default edge type for this graph, and false otherwise.

Parameters:

edgeType - the edge type to compare to this instance's default edge type

validateEdgeType

protected void validateEdgeType(EdgeType edgeType)

Throws an IllegalArgumentException if edge_type does not match the default edge type for this graph.

Parameters:

edgeType - the edge type to compare to this instance's default edge type