Gephi Toolkit Javadoc

org.gephi.graph.api
Interface EdgeData

All Superinterfaces:
Attributable, Renderable, Spatial

public interface EdgeData
extends Renderable, Attributable

Contains all extended data related to an edge, including access to its attributes.

Author:
Mathieu Bastian
See Also:
getAttributes()

Method Summary
 Attributes getAttributes()
          Gets the access to the attributes, all the custom data related to this object.
 Edge getEdge()
          Returns the edge this edge data belongs.
 java.lang.String getId()
          Returns the string identifier of this edge.
 java.lang.String getLabel()
          Returns the edge label, or null if none has been set.
<T extends LayoutData>
T
getLayoutData()
          Returns the layout data object associated to this edge.
 NodeData getSource()
          Returns the edge source node data.
 NodeData getTarget()
          Returns the edge target node data.
 void setLabel(java.lang.String label)
          Sets this edge label.
 void setLayoutData(LayoutData layoutData)
          Sets the layout data of this edge.
 
Methods inherited from interface org.gephi.graph.api.Renderable
alpha, b, g, getModel, getRadius, getSize, getTextData, r, setAlpha, setB, setColor, setG, setModel, setR, setSize, setX, setY, setZ
 
Methods inherited from interface org.gephi.graph.api.Spatial
x, y, z
 

Method Detail

getEdge

Edge getEdge()
Returns the edge this edge data belongs.

Returns:
the edge

getSource

NodeData getSource()
Returns the edge source node data. Similar as getEdge().getSource().getNodeData().

Returns:
the edge source node

getTarget

NodeData getTarget()
Returns the edge target node data. Similar as getEdge().getSource().getNodeData().

Returns:
the edge source node

getId

java.lang.String getId()
Returns the string identifier of this edge. This identifier can be set by users, in contrario of Edge.getId() which is set by the system.

Use Graph.getEdge(String) to find edges from this id.

If no identifier has been set, returns the system integer identifier.

Returns:
the node identifier

getLabel

java.lang.String getLabel()
Returns the edge label, or null if none has been set.

Returns:
the edge lable, or null

setLabel

void setLabel(java.lang.String label)
Sets this edge label.

Parameters:
label - the label that is to be set as this edge label

getLayoutData

<T extends LayoutData> T getLayoutData()
Returns the layout data object associated to this edge. Layout data are temporary data layout algorithms can push to edges to save states when computing.

Type Parameters:
T - must inherit from LayoutData
Returns:
the layout data of this edge, can be null

setLayoutData

void setLayoutData(LayoutData layoutData)
Sets the layout data of this edge. Layout data are temporary data layout algorithms can push to edges to save states when computing.

Parameters:
layoutData - the layout data that is to be set for this edge

getAttributes

Attributes getAttributes()
Gets the access to the attributes, all the custom data related to this object.

Specified by:
getAttributes in interface Attributable
Returns:
the attributes of this edge

Gephi Toolkit Javadoc