org.girod.jgraphml.model

Class GraphMLEdge

java.lang.Object

org.girod.jgraphml.model.AbstractIDElement

org.girod.jgraphml.model.GraphMLEdge

All Implemented Interfaces:

java.lang.Cloneable, EdgeType, IDElement, Labeled, LabeledElement

Direct Known Subclasses:

GraphMLEdgeTemplate

public class GraphMLEdge
extends AbstractIDElement
implements LabeledElement, EdgeType

A graphml edge.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<EdgeLabel>	additionalLabels The additional labels.

Fields inherited from class org.girod.jgraphml.model.AbstractIDElement

id

Fields inherited from interface org.girod.jgraphml.model.EdgeType

POLYLINE_EDGE, QUADCURVE_EDGE

Constructor Summary

Constructors

Constructor and Description
GraphMLEdge(AbstractGraphMLDiagram diagram, java.lang.String id) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalLabel(EdgeLabel label) Create an additional label.
GraphMLEdge	clone()
EdgeLabel	createAdditionalLabel() Create an additional label.
EdgeLabel	createAdditionalLabel(java.lang.String label) Create an additional label, with a specified ratio.
EdgeLabel	createAdditionalLabel(java.lang.String label, float ratio) Create an additional label, with a specified ratio.
EdgeLabel	createLabel(boolean createIfExist) Create the edge associated label.
java.util.List<EdgeLabel>	getAdditionalLabels() Return the list of additional labels.
Arrows	getArrows() Return the edge arrows.
java.lang.String	getDescription() Return the element description.
short	getEdgeType() Return the edge type.
java.lang.String	getID() Returns the edge id.
EdgeLabel	getLabel() Return the edge associated label.
java.lang.String	getLabelText() Return the element label text.
LineStyle	getLineStyle() Return the edge line style.
Path	getPath() Return the edge path.
PortConstraints	getPortConstraints() Return the port constraints on the edge.
IGraphMLNode	getSource() Return the edge source.
IGraphMLNode	getTarget() Return the edge target.
boolean	hasAdditionalLabels() Return true if the edge has additional labels.
boolean	hasConstraints() Return true if there is a port constraints on the edge.
boolean	hasLabel() Return true if the edge has a main label.
boolean	isSmoothed() Return true if the edge is smoothed.
void	setArrows(Arrows arrows) Set the edge arrows.
protected void	setDefaults() Set the defaults.
void	setDescription(java.lang.String desc) Set the element description.
void	setEdgeType(short edgeType) Set the edge type.
void	setLabel(EdgeLabel edgeLabel) Set the edge label.
EdgeLabel	setLabel(java.lang.String text) Set the element label text.
EdgeLabel	setLabel(java.lang.String text, float ratio) Set the element label text.
void	setLineStyle(LineStyle lineStyle) Set the edge line style.
void	setPath(Path path) Set the edge path.
boolean	setPortConstraint(short element, short side) Set a port constraint on the edge.
boolean	setPortConstraint(java.lang.String element, java.lang.String side) Set a port constraint on the edge.
void	setSmoothed(boolean smoothed) Set if the edge is smoothed.
void	setSource(IGraphMLNode source) Return the edge source.
void	setTarget(IGraphMLNode target) Set the edge target.
void	updateLabel() Called when the label is updated.

Methods inherited from class org.girod.jgraphml.model.AbstractIDElement

getURL, getURLAsString, hasURL, setURL, setURL

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.girod.jgraphml.model.LabeledElement

createLabelPlacement, getLabelPlacement

Methods inherited from interface org.girod.jgraphml.model.IDElement

getURL, getURLAsString, hasDescription, hasURL, isTemplate, setURL, setURL

Field Detail

additionalLabels

protected final java.util.List<EdgeLabel> additionalLabels

The additional labels.

Constructor Detail

GraphMLEdge

public GraphMLEdge(AbstractGraphMLDiagram diagram,
                   java.lang.String id)

Constructor.

Parameters:

diagram - the diagram

id - the edge id

Method Detail

clone

public GraphMLEdge clone()

Overrides:

clone in class AbstractIDElement

setDefaults

protected void setDefaults()

Set the defaults.

setEdgeType

public void setEdgeType(short edgeType)

Set the edge type.

Parameters:

edgeType - the type

See Also:

EdgeType

getEdgeType

public short getEdgeType()

Return the edge type.

Returns:

the type

setSmoothed

public void setSmoothed(boolean smoothed)

Set if the edge is smoothed.

Parameters:

smoothed - true if the edge is smoothed

isSmoothed

public boolean isSmoothed()

Return true if the edge is smoothed.

Returns:

true if the edge is smoothed

setSource

public void setSource(IGraphMLNode source)

Return the edge source.

Parameters:

source - the source

getSource

public IGraphMLNode getSource()

Return the edge source.

Returns:

the source

setTarget

public void setTarget(IGraphMLNode target)

Set the edge target.

Parameters:

target - the target

getTarget

public IGraphMLNode getTarget()

Return the edge target.

Returns:

the target

getID

public java.lang.String getID()

Returns the edge id.

Specified by:

getID in interface IDElement

Overrides:

getID in class AbstractIDElement

Returns:

the edge id

setDescription

public void setDescription(java.lang.String desc)

Set the element description.

Specified by:

setDescription in interface IDElement

Overrides:

setDescription in class AbstractIDElement

Parameters:

desc - the description

getDescription

public java.lang.String getDescription()

Return the element description.

Specified by:

getDescription in interface IDElement

Overrides:

getDescription in class AbstractIDElement

Returns:

the description

setPath

public void setPath(Path path)

Set the edge path.

Parameters:

path - the path

getPath

public Path getPath()

Return the edge path.

Returns:

the path

setArrows

public void setArrows(Arrows arrows)

Set the edge arrows.

Parameters:

arrows - the arrows

getArrows

public Arrows getArrows()

Return the edge arrows.

Returns:

the arrows

hasConstraints

public boolean hasConstraints()

Return true if there is a port constraints on the edge.

Returns:

true if there is a port constraints on the edge

getPortConstraints

public PortConstraints getPortConstraints()

Return the port constraints on the edge.

Returns:

the port constraints

setPortConstraint

public boolean setPortConstraint(short element,
                                 short side)

Set a port constraint on the edge.

Parameters:

element - the element

side - the side constraint

Returns:

true if the constraint could be set or unset

setPortConstraint

public boolean setPortConstraint(java.lang.String element,
                                 java.lang.String side)

Set a port constraint on the edge.

Parameters:

element - the element

side - the side constraint

Returns:

true if the constraint could be set or unset

setLineStyle

public void setLineStyle(LineStyle lineStyle)

Set the edge line style.

Parameters:

lineStyle - the line style

getLineStyle

public LineStyle getLineStyle()

Return the edge line style.

Returns:

the line style

setLabel

public void setLabel(EdgeLabel edgeLabel)

Set the edge label.

Parameters:

edgeLabel - the label

getLabel

public EdgeLabel getLabel()

Return the edge associated label.

Specified by:

getLabel in interface LabeledElement

Returns:

the label

hasLabel

public boolean hasLabel()

Return true if the edge has a main label.

Returns:

true if the edge has a main label

updateLabel

public void updateLabel()

Called when the label is updated. Do nothing.

Specified by:

updateLabel in interface LabeledElement

createLabel

public EdgeLabel createLabel(boolean createIfExist)

Create the edge associated label.

Specified by:

createLabel in interface LabeledElement

Parameters:

createIfExist - true if a new label will be created even if it already exists

Returns:

the label

addAdditionalLabel

public void addAdditionalLabel(EdgeLabel label)

Create an additional label.

Parameters:

label - the additional label

createAdditionalLabel

public EdgeLabel createAdditionalLabel(java.lang.String label)

Create an additional label, with a specified ratio.

Parameters:

label - the label

Returns:

the additional label

createAdditionalLabel

public EdgeLabel createAdditionalLabel(java.lang.String label,
                                       float ratio)

Create an additional label, with a specified ratio.

Parameters:

label - the label

ratio - the label ratio

Returns:

the additional label

createAdditionalLabel

public EdgeLabel createAdditionalLabel()

Create an additional label.

Returns:

the additional label

getAdditionalLabels

public java.util.List<EdgeLabel> getAdditionalLabels()

Return the list of additional labels.

Returns:

the list of additional labels

hasAdditionalLabels

public boolean hasAdditionalLabels()

Return true if the edge has additional labels.

Returns:

true if the edge has additional labels

setLabel

public EdgeLabel setLabel(java.lang.String text,
                          float ratio)

Set the element label text.

Parameters:

text - the label text

ratio - the label ratio

Returns:

the label

setLabel

public EdgeLabel setLabel(java.lang.String text)

Set the element label text.

Specified by:

setLabel in interface Labeled

Parameters:

text - the label text

Returns:

the label

getLabelText

public java.lang.String getLabelText()

Return the element label text.

Specified by:

getLabelText in interface LabeledElement

Returns:

the label text