edu.uci.ics.jung.graph.impl
Class BipartiteEdge

java.lang.Object
  extended by edu.uci.ics.jung.utils.UserDataDelegate
      extended by edu.uci.ics.jung.graph.impl.AbstractElement
          extended by edu.uci.ics.jung.graph.impl.AbstractArchetypeEdge
              extended by edu.uci.ics.jung.graph.impl.AbstractSparseEdge
                  extended by edu.uci.ics.jung.graph.impl.UndirectedSparseEdge
                      extended by edu.uci.ics.jung.graph.impl.BipartiteEdge
All Implemented Interfaces:
ArchetypeEdge, Edge, Element, UndirectedEdge, UserDataContainer, Cloneable
Direct Known Subclasses:
BipartiteGraphCollapser.CollapsedBipartiteEdge

public class BipartiteEdge
extends UndirectedSparseEdge

A simple extension of the UndirectedSparseEdge, except with careful bounds checking. The constructor throws a FatalException if its vertices are not in two classes of a BipartiteGraph. (In fact, the Vertices must come in the order CLASSA, CLASSB).

Author:
danyelf

Nested Class Summary
 
Nested classes/interfaces inherited from interface edu.uci.ics.jung.utils.UserDataContainer
UserDataContainer.CopyAction
 
Field Summary
 
Fields inherited from class edu.uci.ics.jung.graph.impl.AbstractSparseEdge
mFrom, mTo
 
Fields inherited from class edu.uci.ics.jung.graph.impl.AbstractElement
id, m_Graph
 
Fields inherited from class edu.uci.ics.jung.utils.UserDataDelegate
factory, udc_delegate
 
Constructor Summary
BipartiteEdge(BipartiteVertex a, BipartiteVertex b)
          The BipartiteEdge constructor.
 
Method Summary
 ArchetypeEdge copy(ArchetypeGraph newGraph)
          Creates a copy of this edge in the specified graph newGraph, and copies this edge's user data to the new edge.
 
Methods inherited from class edu.uci.ics.jung.graph.impl.AbstractSparseEdge
getEndpoints, getIncidentVertices, getOpposite, isIncident, numVertices, toString
 
Methods inherited from class edu.uci.ics.jung.graph.impl.AbstractArchetypeEdge
equals, getEqualEdge, getEquivalentEdge, getIncidentElements
 
Methods inherited from class edu.uci.ics.jung.graph.impl.AbstractElement
addGraph_internal, getGraph, hashCode, initialize, removeGraph_internal
 
Methods inherited from class edu.uci.ics.jung.utils.UserDataDelegate
addUserDatum, clone, containsUserDatumKey, getUserDatum, getUserDatumCopyAction, getUserDatumKeyIterator, importUserData, removeUserDatum, setUserDataFactory, setUserDatum
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface edu.uci.ics.jung.graph.Edge
getEndpoints, getOpposite
 
Methods inherited from interface edu.uci.ics.jung.graph.ArchetypeEdge
getEqualEdge, getEquivalentEdge, getIncidentVertices, isIncident, numVertices
 
Methods inherited from interface edu.uci.ics.jung.graph.Element
getGraph, getIncidentElements
 
Methods inherited from interface edu.uci.ics.jung.utils.UserDataContainer
addUserDatum, clone, containsUserDatumKey, getUserDatum, getUserDatumCopyAction, getUserDatumKeyIterator, importUserData, removeUserDatum, setUserDatum
 

Constructor Detail

BipartiteEdge

public BipartiteEdge(BipartiteVertex a,
                     BipartiteVertex b)
The BipartiteEdge constructor.

Parameters:
a - a Vertex from a BipartiteGraph in CLASSA
b - a Vertex from the same BipartiteGraph in CLASSB
Method Detail

copy

public ArchetypeEdge copy(ArchetypeGraph newGraph)
Description copied from class: AbstractSparseEdge
Creates a copy of this edge in the specified graph newGraph, and copies this edge's user data to the new edge.

Specified by:
copy in interface ArchetypeEdge
Overrides:
copy in class AbstractSparseEdge
Parameters:
newGraph - the graph in which the copied edge will be placed
Returns:
the edge created
See Also:
ArchetypeEdge.copy(edu.uci.ics.jung.graph.ArchetypeGraph)