salvo.jesus.graph

Class EdgeImpl

java.lang.Object

salvo.jesus.graph.EdgeImpl

All Implemented Interfaces:

Serializable, Edge, GraphComponent, LabeledEdge, LabeledGraphComponent

Direct Known Subclasses:

DirectedEdgeImpl, DirectedWeightedEdgeImpl, WeightedEdgeImpl

public class EdgeImpl
extends Object
implements Edge

Represents an undirected edge in a graph.

To do:
Expose the LabeledEdge implementation so that setFollowVertexLabel() can be called to turn it on or off.

Version:

$Id: EdgeImpl.java,v 1.10 2002/08/29 13:20:20 jmsalvo Exp $

Author:

Jesus M. Salvo Jr.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	str The string returned when toString() is called.
protected Vertex	vertexA The A vertex of the edge.
protected Vertex	vertexB The B vertex of the edge.

Constructor Summary

Constructors

Constructor and Description
EdgeImpl(Vertex a, Vertex b) Creates an UndirectedEdge object.

Method Summary

Modifier and Type	Method and Description
protected Object	clone() Creates a clone of this Edge.
String	getLabel()
Vertex	getOppositeVertex(Vertex v) Returns the Vertex opposite to the specified Vertex in the edge.
Vertex	getVertexA() Returns the endpoint A of the edge.
Vertex	getVertexB() Returns the endpoint B of the edge.
boolean	hasLabel()
boolean	isFollowVertexLabel()
void	setFollowVertexLabel(boolean isFollow) Specifies if the edge should follow the labels of its vertices.
void	setLabel(String label) Set the label on this component.
String	toString() Returns a String representation of the Edge.

Methods inherited from class java.lang.Object

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

Field Detail

vertexA

protected Vertex vertexA

The A vertex of the edge.

vertexB

protected Vertex vertexB

The B vertex of the edge.

str

protected String str

The string returned when toString() is called.

Constructor Detail

EdgeImpl

public EdgeImpl(Vertex a,
                Vertex b)

Creates an UndirectedEdge object.

See Also:

Vertex

Method Detail

getVertexA

public Vertex getVertexA()

Returns the endpoint A of the edge.

Specified by:

getVertexA in interface Edge

Returns:

Vertex Endpoint A of the edge.

getVertexB

public Vertex getVertexB()

Returns the endpoint B of the edge.

Specified by:

getVertexB in interface Edge

Returns:

Vertex Endpoint B of the edge.

getOppositeVertex

public Vertex getOppositeVertex(Vertex v)

Returns the Vertex opposite to the specified Vertex in the edge.

Specified by:

getOppositeVertex in interface Edge

Returns:

Vertex The Vertex object that is the opposite to the specifid Vertex. If the specified Vertex is not an endpoint of the edge, returns null.

hasLabel

public boolean hasLabel()

Specified by:

hasLabel in interface LabeledGraphComponent

Returns:

does this component have a label? In some graphs, labeling may be optional, in which case this method may return true for some or all components.

getLabel

public String getLabel()

Specified by:

getLabel in interface LabeledGraphComponent

Returns:

the label associated with this component; if hasLabel() returns false, the result of getLabel() is undefined

setLabel

public void setLabel(String label)

Description copied from interface: LabeledGraphComponent

Set the label on this component. In many cases, attempting to reassign a label after one has already been set will cause an assertion failure.

Specified by:

setLabel in interface LabeledGraphComponent

Parameters:

label - the new label to assign to the component

isFollowVertexLabel

public boolean isFollowVertexLabel()

Specified by:

isFollowVertexLabel in interface LabeledEdge

Returns:

whether or not it follows the labels of its vertices, including any changes, to make sure the label for the edge is consistent with the label of the vertex.

setFollowVertexLabel

public void setFollowVertexLabel(boolean isFollow)

Description copied from interface: LabeledEdge

Specifies if the edge should follow the labels of its vertices.

Specified by:

setFollowVertexLabel in interface LabeledEdge

toString

public String toString()

Returns a String representation of the Edge. By default, the format is: fromVertex.toString() + "->" + toVertex.toString()

Overrides:

toString in class Object

Returns:

The String representation of the Edge

See Also:

Vertex

clone

protected Object clone()

Creates a clone of this Edge. This calls the EdgeImpl constructor, thereby creating a new instance of EdgeImpl. However, the vertices in both endpoints of the Edge are not cloned.

Overrides:

clone in class Object

Returns:

A clone of an instance of Edge.