Package com.amalgamasimulation.visualsets

Class AbstractLineVisualSet<T>

java.lang.Object

com.amalgamasimulation.visualsets.VisualSet<T>

com.amalgamasimulation.visualsets.AbstractLineVisualSet<T>

Type Parameters:

T - visual set data elements type

All Implemented Interfaces:

ILegendNodePropertiesOwner, IMinMaxValuePropertyOwner, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet

Direct Known Subclasses:

AbstractPolylineVisualSet, LineVisualSet

public abstract class AbstractLineVisualSet<T>
extends VisualSet<T>
implements IMinMaxValuePropertyOwner, IUpdatePolicyPropertyOwner, ILegendNodePropertiesOwner

Parent for all visual sets drawn on the chart by points and lines.

Author:

Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractLineVisualSet.AbstractLineVisualElement	Internal class that represents visual element for line data element.
static enum	AbstractLineVisualSet.Extrapolation	Enumeration defining extrapolation, i.e.
static enum	AbstractLineVisualSet.PointsAndLinesStyle	Enumeration defining whether to draw points, lines, both, or nothing for a line plot.

Nested classes/interfaces inherited from class com.amalgamasimulation.visualsets.VisualSet

VisualSet.ContextMenuHandler<T>, VisualSet.UpdatePolicy, VisualSet.VisualElement

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractLineVisualSet.Extrapolation	extrapolation
protected Supplier<String>	legendTextProvider
protected Color	lineColor
protected LineStyle	lineStyle
protected double	lineWidth
protected Supplier<Double>	maxValueProvider
protected AbstractLineVisualSet.PointsAndLinesStyle	pointsAndLinesStyle
protected double	pointSize
protected Function<T,Double>	valueExtractor
protected Supplier<Double>	valueMultiplier
protected Supplier<Double>	valueShift

Fields inherited from class com.amalgamasimulation.visualsets.VisualSet

argumentExtractor, contentsToBeginArguments, contentsToEndArguments, contentsToVisualElements, contextMenuHandlers, dataElementsProvider, listeners, maxArgument, maxValueCache, minArgument, minValueCache, mouseEnterHandlers, mouseExitHandlers, mousePressedHandlers, mouseTransparent, name, needsUpdate, oldContentsList, tooltipTextExtractor, updatePolicy, visibilityChangeHandlers, visualElementsList

Constructor Summary

Constructors

Constructor	Description
AbstractLineVisualSet(String name, Supplier<List<T>> dataElementsProvider, Function<T,Double> argumentExtractor, Function<T,Double> valueExtractor)	Constructs an AbstractLineVisualSet with given name, data elements and arguments/value extractors, i.e.

Method Summary

Modifier and Type	Method	Description
AbstractLineVisualSet.Extrapolation	getExtrapolation()	Returns the AbstractLineVisualSet.Extrapolation of the plot.
Color	getLegendColor()	Returns the color of the legend's icon corresponding to this VisualSet
String	getLegendText()	Returns the legend label text represents this visual set.
Color	getLineColor()	Returns the line color of the plot.
LineStyle	getLineStyle()	Returns the LineStyle of the plot.
double	getLineWidth()	Returns the line width of the plot, in pixels.
final double	getMaxValue()	Returns the maximum Y-axis value for all data elements.
double	getMinValue()	Returns the minimum Y-axis value for all data elements.
AbstractLineVisualSet.PointsAndLinesStyle	getPointsAndLinesStyle()	Returns the AbstractLineVisualSet.PointsAndLinesStyle of the plot.
double	getPointSize()	Returns the diameter of points of the plot, in pixels.
double	getValue(T element)	Returns the value of the given data element.
double	getValueMultiplier()	Returns value multiplier for correct display on the chart.
double	getValueShift()	Returns value shift for correct display on the chart.
AbstractLineVisualSet<T>	setExtrapolation(AbstractLineVisualSet.Extrapolation extrapolation)	Sets the of the plot i.e.
AbstractLineVisualSet<T>	setLegendText(Supplier<String> legendTextProvider)	Sets the legend label text represents this visual set.
AbstractLineVisualSet<T>	setLineColor(Color lineColor)	Sets the line color of the plot.
AbstractLineVisualSet<T>	setLineStyle(LineStyle lineStyle)	Sets the LineStyle of the plot i.e.
AbstractLineVisualSet<T>	setLineWidth(double lineWidth)	Sets the width of the line, in pixels.
AbstractLineVisualSet<T>	setMaxValue(Supplier<Double> maxValueProvider)	Sets the supplier of max value.
AbstractLineVisualSet<T>	setPointsAndLinesStyle(AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle)	Sets the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e.
AbstractLineVisualSet<T>	setPointSize(double pointSize)	Sets the diameter of the point, in pixels.
AbstractLineVisualSet<T>	withValueMultiplier(Supplier<Double> valueMultiplier)	Sets value multiplier for correct display on the chart.
AbstractLineVisualSet<T>	withValueShift(Supplier<Double> valueShift)	Sets value shift for correct display on the chart.

Methods inherited from class com.amalgamasimulation.visualsets.VisualSet

addContextMenuHandler, addMouseEnterHandler, addMouseExitHandler, addMousePressedHandler, addVisibilityChangeHandler, addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, createVisualElement, getArgument, getContents, getContextMenuHandlers, getDataElements, getInjectionIndex, getMaxArgument, getMinArgument, getMouseEnterHandlers, getMouseExitHandlers, getMousePressedHandlers, getName, getTooltipText, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementIndex, getVisibleVisualElementsCount, getVisualElements, isMouseTransparent, isNeedsUpdate, recalculateVisualElements, removeContextMenuHandler, removeMouseEnterHandler, removeMouseExitHandler, removeMousePressedHandler, removeVisibilityChangeHandler, removeVisualElement, removeVisualSetChangeHandler, setMouseTransparent, setTooltipText, setUpdatePolicy, sortVisualElements, toString, update, updateMinMaxArguments, updateMinMaxArgumentsValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amalgamasimulation.visualsets.IUpdatePolicyPropertyOwner

getUpdatePolicy, setUpdatePolicy

Field Details

lineColor

protected Color lineColor

lineWidth

protected double lineWidth

pointSize

protected double pointSize

pointsAndLinesStyle

protected AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle

lineStyle

protected LineStyle lineStyle

extrapolation

protected AbstractLineVisualSet.Extrapolation extrapolation

valueExtractor

protected Function<T,Double> valueExtractor

maxValueProvider

protected Supplier<Double> maxValueProvider

legendTextProvider

protected Supplier<String> legendTextProvider

valueMultiplier

protected Supplier<Double> valueMultiplier

valueShift

protected Supplier<Double> valueShift

Constructor Details

AbstractLineVisualSet

public AbstractLineVisualSet(String name,
 Supplier<List<T>> dataElementsProvider,
 Function<T,Double> argumentExtractor,
 Function<T,Double> valueExtractor)

Constructs an AbstractLineVisualSet with given name, data elements and arguments/value extractors, i.e. a functions that specifies the rule for extracting an argument/value from a data element.

Parameters:

name - visual set name is used to sort and name the visual sets on the chart

dataElementsProvider - data elements list provider. The provider is invalidated every time the chart is being redrawn

argumentExtractor - a function that specifies the rule for extracting an argument from a data element

valueExtractor - a function that specifies the rule for extracting a value from a data element

Method Details

setMaxValue

public AbstractLineVisualSet<T> setMaxValue(Supplier<Double> maxValueProvider)

Sets the supplier of max value. This value allows to set some "natural" max value of the data being displayed It will be used when scaling the Y-axis of the chart.

Parameters:

maxValueProvider - the supplier of max value

Returns:

reference to this object

setLineColor

public AbstractLineVisualSet<T> setLineColor(Color lineColor)

Sets the line color of the plot. Transparent and semi-transparent colors are allowed.

Parameters:

lineColor - the line color of the plot

Returns:

reference to this object

setLineWidth

public AbstractLineVisualSet<T> setLineWidth(double lineWidth)

Sets the width of the line, in pixels.

Parameters:

lineWidth - the width of the line, in pixels

Returns:

reference to this object

setPointSize

public AbstractLineVisualSet<T> setPointSize(double pointSize)

Sets the diameter of the point, in pixels.

Parameters:

pointSize - the diameter of the point, in pixels

Returns:

reference to this object

setPointsAndLinesStyle

public AbstractLineVisualSet<T> setPointsAndLinesStyle(AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle)

Sets the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e. the methodology of drawing the visual elements for data elements.

Parameters:

pointsAndLinesStyle - the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e. the methodology of drawing the visual elements for data elements

Returns:

reference to this object

setLineStyle

public AbstractLineVisualSet<T> setLineStyle(LineStyle lineStyle)

Sets the LineStyle of the plot i.e. the methodology of drawing the lines for data elements.

Parameters:

lineStyle - the LineStyle of the plot i.e. the methodology of drawing the lines for data elements

Returns:

reference to this object

setExtrapolation

public AbstractLineVisualSet<T> setExtrapolation(AbstractLineVisualSet.Extrapolation extrapolation)

Sets the of the plot i.e. mode of extending a line to the maximum argument among all visual sets or to the current argument along the horizontal axis. Applicable only for AbstractLineVisualSet.

Parameters:

extrapolation - the AbstractLineVisualSet.Extrapolation of the plot

Returns:

reference to this object

setLegendText

public AbstractLineVisualSet<T> setLegendText(Supplier<String> legendTextProvider)

Description copied from interface: ILegendNodePropertiesOwner

Sets the legend label text represents this visual set.

Specified by:

setLegendText in interface ILegendNodePropertiesOwner

Parameters:

legendTextProvider - the legend label text represents this visual set

Returns:

reference to this object

getExtrapolation

public AbstractLineVisualSet.Extrapolation getExtrapolation()

Returns the AbstractLineVisualSet.Extrapolation of the plot.

Returns:

the AbstractLineVisualSet.Extrapolation of the plot

getValue

public double getValue(T element)

Returns the value of the given data element.

Parameters:

element - data element for which the value is being checked

Returns:

the value of the given data element

getLineColor

public Color getLineColor()

Returns the line color of the plot.

Returns:

the line color of the plot

getLineWidth

public double getLineWidth()

Returns the line width of the plot, in pixels.

Returns:

the line color of the plot

getPointSize

public double getPointSize()

Returns the diameter of points of the plot, in pixels.

Returns:

the point diameter of the plot

getPointsAndLinesStyle

public AbstractLineVisualSet.PointsAndLinesStyle getPointsAndLinesStyle()

Returns the AbstractLineVisualSet.PointsAndLinesStyle of the plot.

Returns:

the AbstractLineVisualSet.PointsAndLinesStyle of the plot

getLineStyle

public LineStyle getLineStyle()

Returns the LineStyle of the plot.

Returns:

the LineStyle of the plot

getMinValue

public double getMinValue()

Description copied from interface: IMinMaxValuePropertyOwner

Returns the minimum Y-axis value for all data elements. The minimum value is recalculated and cached at the moment the chart is redrawn. The method returns the value stored in the cache.

Specified by:

getMinValue in interface IMinMaxValuePropertyOwner

Returns:

the minimum Y-axis value for all data elements

See Also:

• Chart.redraw()

getMaxValue

public final double getMaxValue()

Description copied from interface: IMinMaxValuePropertyOwner

Returns the maximum Y-axis value for all data elements. The maximum value is recalculated and cached at the moment the chart is redrawn. The method returns the value stored in the cache.

Specified by:

getMaxValue in interface IMinMaxValuePropertyOwner

Returns:

the maximum Y-axis value for all data elements

See Also:

• Chart.redraw()

getLegendColor

public Color getLegendColor()

Description copied from interface: ILegendNodePropertiesOwner

Returns the color of the legend's icon corresponding to this VisualSet

Specified by:

getLegendColor in interface ILegendNodePropertiesOwner

Returns:

the color of the legend's icon corresponding to this VisualSet

getLegendText

public String getLegendText()

Description copied from interface: ILegendNodePropertiesOwner

Returns the legend label text represents this visual set.

Specified by:

getLegendText in interface ILegendNodePropertiesOwner

Returns:

the legend label text represents this visual set

getValueMultiplier

public double getValueMultiplier()

Returns value multiplier for correct display on the chart.

Returns:

value multiplier for correct display on the chart

withValueMultiplier

public AbstractLineVisualSet<T> withValueMultiplier(Supplier<Double> valueMultiplier)

Sets value multiplier for correct display on the chart.

Parameters:

valueMultiplier - value multiplier for correct display on the chart

Returns:

reference to this object

getValueShift

public double getValueShift()

Returns value shift for correct display on the chart.

Returns:

value shift for correct display on the chart

withValueShift

public AbstractLineVisualSet<T> withValueShift(Supplier<Double> valueShift)

Sets value shift for correct display on the chart.

Parameters:

valueShift - value shift for correct display on the chart

Returns:

reference to this object