planet.commonapi.results
Interface ResultsEdge

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ResultsEdgeImpl

public interface ResultsEdge

extends java.io.Serializable

This wrapper class is used to store an edge of a directed or undirected graph based on GML file format.

Any future implementation must incorpore the no arguments constructor.

Author:

Marc Sanchez , Jordi Pujol

See Also:

GML

Method Summary

java.lang.String	getFill()
Id	getSource()
Id	getTarget()
boolean	isDirected()
void	setDirected(boolean isDirected)
void	setFill(java.lang.String fill)
void	setSource(Id source)
void	setTarget(Id target)
ResultsEdge	setValues(Id source, Id target, boolean isDirected, java.lang.String fill) Sets the values for this edge.

Method Detail

getFill

public java.lang.String getFill()

Returns:

Returns the fill color of the edge.

setFill

public void setFill(java.lang.String fill)

Parameters:

fill - The fill color of the edge to set.

getSource

public Id getSource()

Returns:

Returns the source.

setSource

public void setSource(Id source)

Parameters:

source - The source to set.

getTarget

public Id getTarget()

Returns:

Returns the target.

setTarget

public void setTarget(Id target)

Parameters:

target - The target to set.

isDirected

public boolean isDirected()

Returns:

Returns the isDirected.

setDirected

public void setDirected(boolean isDirected)

Parameters:

isDirected - The isDirected to set.

setValues

public ResultsEdge setValues(Id source,
                             Id target,
                             boolean isDirected,
                             java.lang.String fill)

Sets the values for this edge.

Parameters:

source - Source node.

target - Target node.

isDirected - True when the edge is directed.

fill - The color for the edge.

Returns:

The same instance after it has been updated.