structure
Class ComparableEdge<V,E extends java.lang.Comparable<E>>

java.lang.Object
  structure.Edge<V,E>
      structure.ComparableEdge<V,E>

All Implemented Interfaces:

java.lang.Comparable<ComparableEdge<V,E>>

public class ComparableEdge<V,E extends java.lang.Comparable<E>>
extends Edge<V,E>
implements java.lang.Comparable<ComparableEdge<V,E>>

A class implementing common edge type among graphs. This class supports both directed and undirected edges. Edge may also have visited flags set and cleared. ComparableEdge differs from edge, however, in that it requires that its lable be of a comparable type.

Typical usage:

     Graph g = new GraphListDirected();
     g.add("harry");
     g.add("sally");
     g.addEdge("harry","sally","friendly");
     ComparableEdge e = new ComparableEdge(g.getEdge("harry","sally"));
     Comparable label = e.label();
     Vertex source = e.here();
     Vertex destination = e.there();
     ComparableEdge e2 = e;
     if(e.compareTo(e2) == 0){
         e.visit();
         e.reset();
     }
     ...
 

See Also:

Graph

Constructor Summary

ComparableEdge(ComparableEdge<V,E> e)
Construct a (possibly directed) edge between two labeled vertices.

ComparableEdge(V vtx1, V vtx2, E label, boolean directed)
Construct a (possibly directed) edge between two labeled vertices.

Method Summary

int	compareTo(ComparableEdge<V,E> other) Compare edge, based on labels.
java.lang.String	toString() Construct a string representation of edge.

Methods inherited from class structure.Edge

equals, hashCode, here, isDirected, isVisited, label, reset, setLabel, there, visit

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ComparableEdge

public ComparableEdge(V vtx1,
                      V vtx2,
                      E label,
                      boolean directed)

Construct a (possibly directed) edge between two labeled vertices. When edge is directed, vtx1 specifies source. When undirected, order of vertices is unimportant. Label on edge is any type, and may be null. Edge is initially unvisited.

Parameters:

vtx1 - The label of a vertex (source if directed).

vtx2 - The label of another vertex (destination if directed).

label - The label associated with the edge.

directed - True iff this edge is directed.

Post:

edge associates vtx1 and vtx2. labeled with label directed if "directed" set true

ComparableEdge

public ComparableEdge(ComparableEdge<V,E> e)

Construct a (possibly directed) edge between two labeled vertices. When edge is directed, vtx1 specifies source. When undirected, order of vertices is unimportant. Label on edge is any type, and may be null. Edge is initially unvisited.

Parameters:

e - The edge to be used as the basis for a comparable edge

Post:

edge associates vtx1 and vtx2. labeled with label. directed if "directed" set true

Method Detail

compareTo

public int compareTo(ComparableEdge<V,E> other)

Compare edge, based on labels.

Specified by:

compareTo in interface java.lang.Comparable<ComparableEdge<V,E extends java.lang.Comparable<E>>>

Pre:

labels are Comparable

Post:

returns integer representing relation between labels

toString

public java.lang.String toString()

Construct a string representation of edge.

Overrides:

toString in class Edge<V,E extends java.lang.Comparable<E>>

Returns:

String representing edge.

Post:

returns string representation of edge