org.eth.cyril.graphdrawing.graph.edge

Class Edge

java.lang.Object

org.eth.cyril.graphdrawing.graph.edge.Edge

All Implemented Interfaces:

JsonSerializable

public class Edge
extends java.lang.Object
implements JsonSerializable

An edge of a graph.

Constructor Summary

Constructors

Constructor and Description
Edge(Node from, Node to) Creates a new edge between the two nodes.
Edge(Node from, Node to, double weight) Creates a new edge between the two nodes with the given weight.
Edge(Node from, Node to, double weight, java.lang.Object value) Creates a new edge between the two nodes with the given weight and the given value object for the edge.

Method Summary

Modifier and Type	Method and Description
void	add() Adds this edge from both source and target.
DrawableEdge	getDrawableEdge() Gets the drawable edge for this node.
Node	getFrom() Returns the source node of this edge.
Node	getOther(Node first) Returns the other node in this edge.
Node	getTo() Returns the target node of this edge.
java.lang.Object	getValue() Returns the value stored at this edge.
double	getWeight() Returns the weight of this edge.
java.util.List<Position>	intermediatePositions() Returns the list of intermediate positions.
void	invert() Inverts this edge.
void	remove() Removes this edge from both source and target.
void	setDrawableEdge(DrawableEdge drawableEdge) Sets the drawable edge for this node.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eth.cyril.util.serialization.JsonSerializable

fromJson, toJson

Constructor Detail

Edge

public Edge(Node from,
            Node to)

Creates a new edge between the two nodes. The weight is set to 1.0 by default.

Parameters:

from - The source node.

to - The target node.

Edge

public Edge(Node from,
            Node to,
            double weight)

Creates a new edge between the two nodes with the given weight.

Parameters:

from - The source node.

to - The target node.

weight - The weight. Must be strictly positive.

Throws:

java.lang.IllegalStateException - If the weight is not greater than 0.

Edge

public Edge(Node from,
            Node to,
            double weight,
            java.lang.Object value)

Creates a new edge between the two nodes with the given weight and the given value object for the edge.

Parameters:

from - The source node.

to - The target node.

weight - The weight. Must be strictly positive.

value - The value to store in the node.

Throws:

java.lang.IllegalStateException - If the weight is not greater than 0.

Method Detail

getWeight

public double getWeight()

Returns the weight of this edge. The weight is greater than 0.

getFrom

public Node getFrom()

Returns the source node of this edge.

getTo

public Node getTo()

Returns the target node of this edge.

getOther

public Node getOther(Node first)

Returns the other node in this edge. If the given node is the source, then the target is returned, and vice versa. Behavior if the node is neither source nor target is not defined.

Parameters:

first - The node which is either source or target of this edge.

Returns:

The other node of this edge, which is not equal to first.

getValue

public java.lang.Object getValue()

Returns the value stored at this edge. May be null, as edges don't need to contain a value.

setDrawableEdge

public void setDrawableEdge(DrawableEdge drawableEdge)

Sets the drawable edge for this node.

Parameters:

drawableEdge - The drawable edge for this node.

getDrawableEdge

public DrawableEdge getDrawableEdge()

Gets the drawable edge for this node.

Returns:

The drawable edge for this node.

intermediatePositions

public java.util.List<Position> intermediatePositions()

Returns the list of intermediate positions. Equal to calling DrawableEdge.intermediatePositions(Position, Position) with the position of the source and target of this edge.

Returns:

The list of intermediate positions. Position of source is the first, position of target the last element in the list.

invert

public void invert()

Inverts this edge. The source becomes the target and vice versa.

remove

public void remove()

Removes this edge from both source and target. The edge itself still exists and can be added again.

add

public void add()

Adds this edge from both source and target. The edge should previously have been removed, or behavior is not well-defined. An edge is automatically added upon creation, so this method ONLY needs to be called if remove was explicitly called before.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object