Class UMLConnector

java.lang.Object

org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.internal.XMLElementImpl

org.tquadrat.foundation.javadoc.internal.foundation.xml.builder.spi.XMLElementAdapter

org.tquadrat.foundation.javadoc.internal.foundation.svg.internal.SVGElementImpl

org.tquadrat.foundation.javadoc.internal.foundation.svg.SVGElementAdapter

org.tquadrat.foundation.javadoc.umlgraph.UMLConnector

All Implemented Interfaces:

AllowsConditionalProcessingAttributes, AllowsDocumentElementEventAttributes, AllowsDocumentEventAttributes, AllowsGlobalEventAttributes, AllowsGraphicalEventAttributes, AllowsPresentationAttributes, AllowsStyleAttributes, AllowsXLinkAttributes, SVGClipPath, SVGElement, SVGElementWithChildren, SVGGroup, SVGLine, SVGMarker, SVGPath, SVGPositionedMarker, SVGRectangle, SVGStyle, SVGSymbol, SVGText, SVGTSpan, SVGUse, Element, XMLElement

@ClassVersion(sourceVersion="$Id: UMLConnector.java 1133 2024-05-10 21:43:08Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public final class UMLConnector
extends SVGElementAdapter

The representation of the lines that connects the type elements in a UML diagram.

Instances of this class are used as if they are an instance of SVGPath.

Author:

Thomas Thrien - thomas.thrien@tquadrat.org

Version:

$Id: UMLConnector.java 1133 2024-05-10 21:43:08Z tquadrat $

Since:

0.0.5

Nested Class Summary

Nested classes/interfaces inherited from interface XMLElement

XMLElement.Flags

Field Summary

Fields

Modifier and Type	Field	Description
private final TypeSymbol	m_Child	The type symbol for the child (where the connector starts).
private final UMLConnectorType	m_ConnectorType	The type for this connector.
private Point	m_EndPoint	The end point for the path representing this connector.
private final TypeSymbol	m_Parent	The type symbol for the parent (where the connector ends).
private Point	m_StartPoint	The start point for the path representing this connector.

Fields inherited from interface AllowsConditionalProcessingAttributes

CONDITIONALPROCESSING_ATTRIBUTES

Fields inherited from interface AllowsDocumentElementEventAttributes

DOCUMENTELEMENTEVENT_ATTRIBUTES

Fields inherited from interface AllowsDocumentEventAttributes

DOCUMENTEVENT_ATTRIBUTES

Fields inherited from interface AllowsGlobalEventAttributes

GLOBALEVENT_ATTRIBUTES

Fields inherited from interface AllowsGraphicalEventAttributes

GRAPHICALEVENT_ATTRIBUTES

Fields inherited from interface AllowsPresentationAttributes

PRESENTATION_ATTRIBUTES

Fields inherited from interface AllowsStyleAttributes

STYLE_ATTRIBUTES

Fields inherited from interface AllowsXLinkAttributes

XLINK_ATTRIBUTES

Fields inherited from interface SVGElement

CORE_ATTRIBUTES

Fields inherited from interface XMLElement

NO_APPEND

Constructor Summary

Constructors

Constructor	Description
UMLConnector(UMLConnectorType type, TypeSymbol parent, TypeSymbol child)	Creates a new UMLConnector instance.

Method Summary

Modifier and Type	Method	Description
final SVGPath	asSVGPath()	Returns this UMLConnector instance as an instance of SVGPath.
private final SVGPathElement[]	composePath()	Composes the path that represents this UML connector.
final Map<String,String>	getAttributes()	Provides read access to the attributes.
final TypeSymbol	getChildTypeSymbol()	Returns the type symbol where the connector starts.
final TypeSymbol	getParentTypeSymbol()	Returns the type symbol where the connector ends.
final void	setEndPoint(double x, double y)	Sets the end point for the path representing this connector.
final void	setMarkerEnd(URI ignored)	The markers for the path representing this UML connector are set internally, so this method will do nothing.
final void	setMarkerMid(URI ignored)	The markers for the path representing this UML connector are set internally, so this method will do nothing.
final void	setMarkerStart(URI ignored)	The markers for the path representing this UML connector are set internally, so this method will do nothing.
final void	setPathDefinition(SVGPathElement... ignored)	The definition of the path for this UML connector is done internally, so calling this method does not have any effect.
final void	setPathLength(SVGNumber.SVGUserUnitValue ignored)	The definition of the path for this UML connector is done internally, so calling this method does not have any effect.
final void	setStartPoint(double x, double y)	Sets the start point for the path representing this connector.

Methods inherited from class SVGElementAdapter

addStyle, defineLine, getStyleSheet, merge, setClipPathUnits, setDx, setDy, setLengthAdjust, setMarkerHeight, setMarkerUnits, setMarkerWidth, setOrientation, setOrientation, setPathLength, setPathLength, setPosition, setReferenceX, setReferenceY, setRotate, setTextLength, setX, setX1, setX2, setY, setY1, setY2, toString

Methods inherited from class SVGElementImpl

addChild, setAbortHandler, setActivationHandler, setAlignmentBaseline, setAttribute, setBaselineShift, setCancelHandler, setCanPlayHandler, setCanPlayThroughHandler, setChangeHandler, setClass, setClickHandler, setClip, setClipPath, setClipRule, setCloseHandler, setColor, setColorInterpolation, setColorInterpolationFilters, setColorProfile, setColorRendering, setCopyHandler, setCueChangeHandler, setCursor, setCutHandler, setDblClickHandler, setDescription, setDirection, setDisplay, setDominantBaseline, setDragEndHandler, setDragEnterHandler, setDragExitHandler, setDragHandler, setDragLeaveHandler, setDragOverHandler, setDragStartHandler, setDropHandler, setDurationChangeHandler, setEmptiedHandler, setEnableBackground, setEndedHandler, setErrorHandler, setExternalResourcesRequired, setFill, setFillOpacity, setFillRule, setFilter, setFloodColor, setFloodOpacity, setFocusHandler, setFocusInHandler, setFocusOutHandler, setFontFamily, setFontSize, setFontSizeAdjust, setFontStretch, setFontStyle, setFontVariant, setFontWeight, setGlyphOrientationHorizontal, setGlyphOrientationVertical, setHeight, setId, setImageRendering, setInputHandler, setInvalidHandler, setKerning, setKeyDownHandler, setKeyPressHandler, setKeyUpHandler, setLang, setLetterSpacing, setLightingColor, setLoadedDataHandler, setLoadedMetadataHandler, setLoadHandler, setLoadStartHandler, setMask, setMouseDownHandler, setMouseEnterHandler, setMouseLeaveHandler, setMouseMoveHandler, setMouseOutHandler, setMouseOverHandler, setMouseUpHandler, setMouseWheelHandler, setOpacity, setOverflow, setPasteHandler, setPauseHandler, setPlayHandler, setPlayingHandler, setPointerEvents, setPreserveAspectRatio, setPreserveSpace, setProgressHandler, setRateChangeHandler, setReference, setRequiredExtensions, setRequiredFeatures, setResetHandler, setResizeHandler, setRx, setRy, setScrollHandler, setSeekedHandler, setSeekingHandler, setSelectHandler, setShapeRendering, setShowHandler, setStalledHandler, setStopColor, setStopOpacity, setStroke, setStrokeDashArray, setStrokeDashOffset, setStrokeLineCap, setStrokeLineJoin, setStrokeMiterLimit, setStrokeOpacity, setStrokeWidth, setStyle, setSubmitHandler, setSuspendHandler, setSystemLanguage, setTabIndex, setTextAnchor, setTextDecoration, setTextRendering, setTimeUpdateHandler, setTitle, setToggleHandler, setTransform, setUnicodeBidi, setUnloadHandler, setVectorEffect, setViewBox, setVisibility, setVolumeChangeHandler, setWaitHandler, setWidth, setWordSpacing, setWritingMode, setX, setXlinkActuate, setXLinkArcRole, setXLinkReference, setXLinkRole, setXLinkShow, setXLinkTitle, setXLinkType, setXMLBase, setXMLId, setXMLLang, setY, updateRegistries

Methods inherited from class XMLElementImpl

addCDATA, addChild, addComment, addPredefinedMarkup, addText, getAttribute, getChildren, getElementName, getFlags, getNamespaces, getParent, getSortOrder, hasChildren, registerAttributeSequence, registerAttributeSequence, registerValidAttributes, registerValidChildren, retrieveValidAttributes, retrieveValidChildren, setAttribute, setNamespace, setNamespace, setNamespace, setNamespace, setNamespace, setParent, toString

Methods inherited from class Object

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

Methods inherited from interface AllowsConditionalProcessingAttributes

setExternalResourcesRequired, setRequiredExtensions, setRequiredFeatures, setSystemLanguage

Methods inherited from interface AllowsDocumentElementEventAttributes

setCopyHandler, setCutHandler, setPasteHandler

Methods inherited from interface AllowsDocumentEventAttributes

setAbortHandler, setErrorHandler, setResizeHandler, setScrollHandler, setUnloadHandler

Methods inherited from interface AllowsGlobalEventAttributes

setCancelHandler, setCanPlayHandler, setCanPlayThroughHandler, setChangeHandler, setClickHandler, setCloseHandler, setCueChangeHandler, setDblClickHandler, setDragEndHandler, setDragEnterHandler, setDragExitHandler, setDragHandler, setDragLeaveHandler, setDragOverHandler, setDragStartHandler, setDropHandler, setDurationChangeHandler, setEmptiedHandler, setEndedHandler, setErrorHandler, setFocusHandler, setInputHandler, setInvalidHandler, setKeyDownHandler, setKeyPressHandler, setKeyUpHandler, setLoadedDataHandler, setLoadedMetadataHandler, setLoadHandler, setLoadStartHandler, setMouseDownHandler, setMouseEnterHandler, setMouseLeaveHandler, setMouseMoveHandler, setMouseOutHandler, setMouseOverHandler, setMouseUpHandler, setMouseWheelHandler, setPauseHandler, setPlayHandler, setPlayingHandler, setProgressHandler, setRateChangeHandler, setResetHandler, setResizeHandler, setScrollHandler, setSeekedHandler, setSeekingHandler, setSelectHandler, setShowHandler, setStalledHandler, setSubmitHandler, setSuspendHandler, setTimeUpdateHandler, setToggleHandler, setVolumeChangeHandler, setWaitHandler

Methods inherited from interface AllowsGraphicalEventAttributes

setActivationHandler, setFocusInHandler, setFocusOutHandler

Methods inherited from interface AllowsPresentationAttributes

setAlignmentBaseline, setBaselineShift, setClip, setClipPath, setClipRule, setColor, setColorInterpolation, setColorInterpolationFilters, setColorProfile, setColorRendering, setCursor, setDirection, setDisplay, setDominantBaseline, setEnableBackground, setFill, setFillOpacity, setFillRule, setFilter, setFloodColor, setFloodOpacity, setFontFamily, setFontSize, setFontSizeAdjust, setFontStretch, setFontStyle, setFontVariant, setFontWeight, setGlyphOrientationHorizontal, setGlyphOrientationVertical, setImageRendering, setKerning, setLetterSpacing, setLightingColor, setMask, setOpacity, setOverflow, setPointerEvents, setShapeRendering, setStopColor, setStopOpacity, setStroke, setStrokeDashArray, setStrokeDashOffset, setStrokeLineCap, setStrokeLineJoin, setStrokeMiterLimit, setStrokeOpacity, setStrokeWidth, setTextAnchor, setTextDecoration, setTextRendering, setUnicodeBidi, setVectorEffect, setVisibility, setWordSpacing, setWritingMode

Methods inherited from interface AllowsStyleAttributes

setClass, setStyle

Methods inherited from interface AllowsXLinkAttributes

setXlinkActuate, setXLinkArcRole, setXLinkReference, setXLinkRole, setXLinkShow, setXLinkTitle, setXLinkType

Methods inherited from interface Element

getAttribute, getChildren, getElementName, getNamespaces, getParent, hasChildren, isBlock

Methods inherited from interface SVGElement

addComment, getSVGElementCategory, setId, setLang, setPreserveSpace, setTabIndex, setTitle, setXMLBase, setXMLId, setXMLLang

Methods inherited from interface SVGElementWithChildren

addChild, setDescription

Methods inherited from interface SVGLine

setEndPoint, setStartPoint

Methods inherited from interface SVGMarker

setExternalResourcesRequired, setMarkerDimensions, setPreserveAspectRatio, setReferencePoint, setTransform, setViewBox

Methods inherited from interface SVGRectangle

defineRectangle, setHeight, setRx, setRy, setWidth, setX, setY

Methods inherited from interface SVGSymbol

setExternalResourcesRequired, setPreserveAspectRatio, setViewBox

Methods inherited from interface SVGText

addCDATA, addText

Methods inherited from interface SVGTSpan

addCDATA, addText

Methods inherited from interface SVGUse

setHeight, setWidth, setX, setY

Methods inherited from interface XMLElement

addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addCDATA, addText, addText, addText, addText, addText, addText, addText, addText, addText, addText, addText, addText, addText, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeIfNotEmpty, setAttributeIfNotEmpty

Field Details

m_ConnectorType

private final UMLConnectorType m_ConnectorType

The type for this connector.

m_Child

private final TypeSymbol m_Child

The type symbol for the child (where the connector starts).

m_EndPoint

private Point m_EndPoint

The end point for the path representing this connector.

m_Parent

private final TypeSymbol m_Parent

The type symbol for the parent (where the connector ends).

m_StartPoint

private Point m_StartPoint

The start point for the path representing this connector.

Constructor Details

UMLConnector

public UMLConnector(UMLConnectorType type,
 TypeSymbol parent,
 TypeSymbol child)

Creates a new UMLConnector instance.

Parameters:

type - The type for this connector.

parent - The type symbol for the parent (where the connector ends).

child - The type symbol for the child (where the connector starts).

Method Details

asSVGPath

public final SVGPath asSVGPath()

Returns this UMLConnector instance as an instance of SVGPath.

Returns:

This instance.

composePath

private final SVGPathElement[] composePath()

Composes the path that represents this UML connector.

Returns:

The path definition.

getAttributes

public final Map<String,String> getAttributes()

Provides read access to the attributes.

Specified by:

getAttributes in interface Element

Overrides:

getAttributes in class XMLElementImpl

Returns:

A reference to the attributes.

getChildTypeSymbol

public final TypeSymbol getChildTypeSymbol()

Returns the type symbol where the connector starts.

Returns:

The child's type symbol.

getParentTypeSymbol

public final TypeSymbol getParentTypeSymbol()

Returns the type symbol where the connector ends.

Returns:

The parent's type symbol.

setEndPoint

public final void setEndPoint(double x,
 double y)

Sets the end point for the path representing this connector.

Parameters:

x - The x coordinate.

y - The y coordinate.

setMarkerEnd

public final void setMarkerEnd(URI ignored)

The markers for the path representing this UML connector are set internally, so this method will do nothing.

Specified by:

setMarkerEnd in interface AllowsPresentationAttributes

Overrides:

setMarkerEnd in class SVGElementImpl

Parameters:

ignored - Ignored!

See Also:

• SVGUtils.SVGATTRIBUTE_MarkerEnd

setMarkerMid

public final void setMarkerMid(URI ignored)

The markers for the path representing this UML connector are set internally, so this method will do nothing.

Specified by:

setMarkerMid in interface AllowsPresentationAttributes

Overrides:

setMarkerMid in class SVGElementImpl

Parameters:

ignored - Ignored!

See Also:

• SVGUtils.SVGATTRIBUTE_MarkerMid

setMarkerStart

public final void setMarkerStart(URI ignored)

The markers for the path representing this UML connector are set internally, so this method will do nothing.

Specified by:

setMarkerStart in interface AllowsPresentationAttributes

Overrides:

setMarkerStart in class SVGElementImpl

Parameters:

ignored - Ignored!

See Also:

• SVGUtils.SVGATTRIBUTE_MarkerStart

setPathDefinition

public final void setPathDefinition(SVGPathElement... ignored)

The definition of the path for this UML connector is done internally, so calling this method does not have any effect.

Specified by:

setPathDefinition in interface SVGPath

Overrides:

setPathDefinition in class SVGElementAdapter

Parameters:

ignored - Ignored!

setPathLength

public final void setPathLength(SVGNumber.SVGUserUnitValue ignored)

The definition of the path for this UML connector is done internally, so calling this method does not have any effect.

Specified by:

setPathLength in interface SVGLine

Specified by:

setPathLength in interface SVGPath

Specified by:

setPathLength in interface SVGRectangle

Overrides:

setPathLength in class SVGElementImpl

Parameters:

ignored - Ignored!

setStartPoint

public final void setStartPoint(double x,
 double y)

Sets the start point for the path representing this connector.

Parameters:

x - The x coordinate.

y - The y coordinate.