Package com.storedobject.chart

Class SankeyChart.Edge

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.ComposedPart

com.storedobject.chart.SankeyChart.Edge

All Implemented Interfaces:

ComponentPart, ComponentProperty, HasAnimation, HasEmphasis, HasItemStyle, HasLabel, HasPadding, HasPolarProperty, HasPosition

Enclosing class:

SankeyChart

public static class SankeyChart.Edge
extends ComposedPart

Class that defines an edge between 2 Sankey nodes.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Edge(SankeyChart.Node from, SankeyChart.Node to, Number value)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
SankeyChart.Node	getFrom()	Get the starting node of the edge.
protected Class<? extends Label>	getLabelClass()	This is invoked to determine the class of the label to create.
protected String	getLabelTag()
final LineStyle	getLineStyle(boolean create)	Get line style.
SankeyChart.Node	getTo()	Get the ending node of the edge.
protected boolean	hasId()	Whether Id needs to be sent as part of the JSON or not.
final void	setLineStyle(LineStyle lineStyle)	Set the line style.
void	setValue(Number value)	Set the value of the edge.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.ComposedPart

getAnimation, getEmphasis, getItemStyle, getLabel, getPadding, getPolarProperty, getPosition, hide, setAnimation, setEmphasis, setItemStyle, setLabel, setPadding, setPolarProperty, setPosition, show

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getName, getSerial, getZ, hashCode, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getRenderingIndex, setName, setRenderingIndex

Methods inherited from interface com.storedobject.chart.HasPolarProperty

setHoleRadius, setRadius

Constructor Details

Edge

public Edge(SankeyChart.Node from,
 SankeyChart.Node to,
 Number value)

Constructor.

Parameters:

from - Starting node.

to - Ending node.

value - The value of edge, which decides the width of edge..

Method Details

hasId

protected boolean hasId()

Description copied from class: AbstractPart

Whether Id needs to be sent as part of the JSON or not.

Overrides:

hasId in class AbstractPart

Returns:

True/false.

getFrom

public SankeyChart.Node getFrom()

Get the starting node of the edge.

Returns:

Starting node.

getTo

public SankeyChart.Node getTo()

Get the ending node of the edge.

Returns:

Ending node.

validate

public void validate()
              throws ChartException

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Overrides:

validate in class ComposedPart

Throws:

ChartException - Raises exception if the component or part is not valid.

setValue

public void setValue(Number value)

Set the value of the edge.

Parameters:

value - The value of edge, which decides the width of edge..

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class ComposedPart

Parameters:

sb - Encoded JSON string to be appended to this.

getLabelClass

protected Class<? extends Label> getLabelClass()

Description copied from class: ComposedPart

This is invoked to determine the class of the label to create. The class should have a default constructor.

Overrides:

getLabelClass in class ComposedPart

Returns:

Label.

getLabelTag

protected String getLabelTag()

Overrides:

getLabelTag in class AbstractPart

setLineStyle

public final void setLineStyle(LineStyle lineStyle)

Set the line style.

Parameters:

lineStyle - Line style.

getLineStyle

public final LineStyle getLineStyle(boolean create)

Get line style.

Parameters:

create - Pass true if it needs to be created if not exists.

Returns:

Line style.