com.whitestein.lsps.visualization

Class DiagramConnection

java.lang.Object

com.whitestein.lsps.visualization.DiagramConnection

public class DiagramConnection
extends Object

This class represents a connection between two nodes in a diagram.

Author:

jsa

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiagramConnection.Type

Constructor Summary

Constructors

Constructor and Description
DiagramConnection(String id) Creates a new connection of type flow.
DiagramConnection(String id, DiagramConnection.Type type, com.whitestein.lsps.modeler.diagram.DirectionType direction) Creates a connection with the given type and direction.

Method Summary

Modifier and Type	Method and Description
void	addAssignment(Assignment assignment) Adds an assignment to a list of assignment of this diagram connection.
List<Assignment>	getAssignments() Gets unmodifiable view of the list of assignments of this connection.
List<DiagramPoint>	getBendpoints() Gets an ordered list of bend points of this connection.
String	getColor() Gets the connector color
String	getDirection() Gets the direction of this connection.
String	getGuard() Gets the guard expression of this connection
String	getId() Gets the identifier of the connection element.
String	getName() Gets the name of this connection.
String	getSource() Gets the identifier of the source node.
String	getSourceAnchor()
String	getStyle() Gets the line style.
String	getTarget() Gets the identifier of the target node.
String	getTargetAnchor()
String	getTextColor() Gets the text color.
String	getTextFont() Gets the name of the font used by the text
DiagramConnection.Type	getType() Gets the type of this connection.
int	getWidth() Gets the connector width.
boolean	isDefaultFlow() Indicates whether this connection is a default flow.
boolean	isRounded() Indicates if the line is rounded at bend points.
void	setColor(String color) Sets the connector color
void	setDefaultFlow(boolean defaultFlow) Sets the indicator whether this connection is default flow or not.
void	setDirectionEnum(com.whitestein.lsps.modeler.diagram.DirectionType dir) Sets the direction type value.
void	setGuard(String guard) Set the guard expression of this connection
void	setName(String name) Sets the name of this connection.
void	setRounded(boolean rounded) Sets the flag indicating whether the line should be rounded at bend points
void	setSource(String source) Sets the identifier of the source node
void	setSourceAnchor(String sourceAnchor)
void	setStyle(String style) Sets the line style.
void	setTarget(String target) Sets the identifier of the target node.
void	setTargetAnchor(String targetAnchor)
void	setTextColor(String textColor) Sets the text color.
void	setTextFont(String fontName) sets the text font
void	setType(DiagramConnection.Type type) Sets the type of this connection.
void	setWidth(int width) Sets the connector width.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagramConnection

public DiagramConnection(String id)

Creates a new connection of type flow.

Parameters:

id -

DiagramConnection

public DiagramConnection(String id,
                         DiagramConnection.Type type,
                         com.whitestein.lsps.modeler.diagram.DirectionType direction)

Creates a connection with the given type and direction.

Parameters:

id -

type -

direction -

Method Detail

getId

public String getId()

Gets the identifier of the connection element.

Returns:

the identifier of this connection element.

getBendpoints

public List<DiagramPoint> getBendpoints()

Gets an ordered list of bend points of this connection.

Returns:

a list of edge points.

getColor

public String getColor()

Gets the connector color

Returns:

color

setColor

public void setColor(String color)

Sets the connector color

Parameters:

color - the connector color

getWidth

public int getWidth()

Gets the connector width.

Returns:

the connector width

setWidth

public void setWidth(int width)

Sets the connector width.

Parameters:

width - the connector width

getTextColor

public String getTextColor()

Gets the text color.

Returns:

the text color

setTextColor

public void setTextColor(String textColor)

Sets the text color.

Parameters:

textColor - the text color

getTextFont

public String getTextFont()

Gets the name of the font used by the text

Returns:

text font

setTextFont

public void setTextFont(String fontName)

sets the text font

Parameters:

fontName - the name of the text font

getName

public String getName()

Gets the name of this connection.

Returns:

name

setName

public void setName(String name)

Sets the name of this connection.

Parameters:

name -

getGuard

public String getGuard()

Gets the guard expression of this connection

Returns:

guard expression

setGuard

public void setGuard(String guard)

Set the guard expression of this connection

Parameters:

guard -

isDefaultFlow

public boolean isDefaultFlow()

Indicates whether this connection is a default flow.

Returns:

true if this connection is default flow; otherwise false.

setDefaultFlow

public void setDefaultFlow(boolean defaultFlow)

Sets the indicator whether this connection is default flow or not.

Parameters:

defaultFlow -

getSourceAnchor

public String getSourceAnchor()

setSourceAnchor

public void setSourceAnchor(String sourceAnchor)

getTargetAnchor

public String getTargetAnchor()

setTargetAnchor

public void setTargetAnchor(String targetAnchor)

getSource

public String getSource()

Gets the identifier of the source node.

Returns:

source node identifier

setSource

public void setSource(String source)

Sets the identifier of the source node

Parameters:

source -

getTarget

public String getTarget()

Gets the identifier of the target node.

Returns:

the target identifier

setTarget

public void setTarget(String target)

Sets the identifier of the target node.

Parameters:

target -

isRounded

public boolean isRounded()

Indicates if the line is rounded at bend points.

Returns:

true if the line at bend points should be rounded; otherwise false.

setRounded

public void setRounded(boolean rounded)

Sets the flag indicating whether the line should be rounded at bend points

Parameters:

rounded -

getStyle

public String getStyle()

Gets the line style. Possible values are:

• CUSTOM
• DIRECT
• TREE

Returns:

style of the line

setStyle

public void setStyle(String style)

Sets the line style.

Parameters:

style -

See Also:

getStyle()

getType

public DiagramConnection.Type getType()

Gets the type of this connection.

Returns:

the type

setType

public void setType(DiagramConnection.Type type)

Sets the type of this connection.

Parameters:

type - the type to set.

getDirection

public String getDirection()

Gets the direction of this connection. Possible values are:

• NONE
• SOURCE_TO_TARGET
• TARGET_TO_SOURCE
• BIDIRECTIONAL

Returns:

direction of the connection

See Also:

DirectionType

setDirectionEnum

public void setDirectionEnum(com.whitestein.lsps.modeler.diagram.DirectionType dir)

Sets the direction type value.

Parameters:

dir - the direction type

addAssignment

public void addAssignment(Assignment assignment)

Adds an assignment to a list of assignment of this diagram connection.

Parameters:

assignment - an assignment to be added

getAssignments

public List<Assignment> getAssignments()

Gets unmodifiable view of the list of assignments of this connection.

Returns:

An unmodifiable list of assignments.