Package com.amalgamasimulation.visualsets

Class PolylineVisualSet<T>

java.lang.Object

com.amalgamasimulation.visualsets.VisualSet<T>

com.amalgamasimulation.visualsets.AbstractLineVisualSet<T>

com.amalgamasimulation.visualsets.AbstractPolylineVisualSet<T>

com.amalgamasimulation.visualsets.PolylineVisualSet<T>

Type Parameters:

T - visual set data elements type

All Implemented Interfaces:

IClipboardTextPropertyOwner<Double>, ILegendNodePropertiesOwner, IMinMaxValuePropertyOwner, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, ILineChartVisualSet

Direct Known Subclasses:

PiecewisePolylineVisualSet

public class PolylineVisualSet<T>
extends AbstractPolylineVisualSet<T>
implements ILineChartVisualSet

Visual set for drawing plots with lines and points.

Differs from a LineVisualSet in that the data element arguments may not be strictly increasing.

Author:

Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PolylineVisualSet.PolylineVisualElement	Internal class that represents visual element for polyline data element.

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

AbstractPolylineVisualSet.AbstractPolylineVisualElement

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

AbstractLineVisualSet.AbstractLineVisualElement, AbstractLineVisualSet.Extrapolation, AbstractLineVisualSet.PointsAndLinesStyle

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

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

Field Summary

Fields inherited from class com.amalgamasimulation.visualsets.AbstractPolylineVisualSet

clipboardTextExtractor

Fields inherited from class com.amalgamasimulation.visualsets.AbstractLineVisualSet

extrapolation, legendTextProvider, lineColor, lineStyle, lineWidth, maxValueProvider, pointsAndLinesStyle, pointSize, valueExtractor

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
PolylineVisualSet(String name, Supplier<List<T>> dataElementsProvider, Function<T,Double> beginArgumentExtractor, Function<T,Double> valueExtractor)	Constructs a PolylineVisualSet with given name, data elements and arguments/value extractors, i.e.

Method Summary

Modifier and Type	Method	Description
PolylineVisualSet<T>	addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)	Adds the action to be executed every time a context menu for given data element is called.
PolylineVisualSet<T>	addMouseEnterHandler(BiConsumer<T,MouseEvent> handler)	Adds the action to be executed every time mouse enters to any visual element borders.
PolylineVisualSet<T>	addMouseExitHandler(BiConsumer<T,MouseEvent> handler)	Adds the action to be executed every time the mouse exits the previously entered element's bounds.
PolylineVisualSet<T>	addMousePressedHandler(BiConsumer<T,MouseEvent> handler)	Adds the action to be executed every time a mouse button is pressed.
PolylineVisualSet<T>	addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)	Adds the action to be executed every time the visibility of this VisualSet is changed.
PolylineVisualSet<T>.PolylineVisualElement	createVisualElement(T contents)	Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.
protected int	getInjectionIndex(List<VisualSet<T>.VisualElement> list, VisualSet<T>.VisualElement element, T contents, int contentsIndex, Map<VisualSet<T>.VisualElement,Double> beginArgumentsCache)
List<PolylineVisualSet<T>.PolylineVisualElement>	getVisualElements(boolean recalculationRequired)	Returns the list of visual elements corresponding to current data elements.
PolylineVisualSet<T>	setClipboardText(Function<Double,String> clipboardText)	Sets the conversion method from values of each plot data element into text that will be copied to clipboard.
PolylineVisualSet<T>	setExtrapolation(AbstractLineVisualSet.Extrapolation extrapolation)	Sets the of the plot i.e.
PolylineVisualSet<T>	setLegendText(Supplier<String> legendTextProvider)	Sets the legend label text represents this visual set.
PolylineVisualSet<T>	setLineColor(Color color)	Sets the line color of the plot.
PolylineVisualSet<T>	setLineStyle(LineStyle lineStyle)	Sets the LineStyle of the plot i.e.
PolylineVisualSet<T>	setLineWidth(double width)	Sets the width of the line, in pixels.
PolylineVisualSet<T>	setMaxValue(Supplier<Double> maxValueProvider)	Sets the supplier of max value.
PolylineVisualSet<T>	setMouseTransparent(boolean mouseTransparent)	Sets the value of the property mouseTransparent.
PolylineVisualSet<T>	setPointsAndLinesStyle(AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle)	Sets the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e.
PolylineVisualSet<T>	setPointSize(double pointSize)	Sets the diameter of the point, in pixels.
PolylineVisualSet<T>	setTooltipText(Function<T,String> tooltipText)	Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.
PolylineVisualSet<T>	setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)	Sets the new VisualSet.UpdatePolicy i.e.

Methods inherited from class com.amalgamasimulation.visualsets.AbstractPolylineVisualSet

getClipboardText, getValue

Methods inherited from class com.amalgamasimulation.visualsets.AbstractLineVisualSet

getExtrapolation, getLegendColor, getLegendText, getLineColor, getLineStyle, getLineWidth, getMaxValue, getMinValue, getPointsAndLinesStyle, getPointSize, getValue

Methods inherited from class com.amalgamasimulation.visualsets.VisualSet

addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, getArgument, getContents, getContextMenuHandlers, getDataElements, getMaxArgument, getMinArgument, getMouseEnterHandlers, getMouseExitHandlers, getMousePressedHandlers, getName, getTooltipText, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementIndex, getVisibleVisualElementsCount, isMouseTransparent, isNeedsUpdate, recalculateVisualElements, removeContextMenuHandler, removeMouseEnterHandler, removeMouseExitHandler, removeMousePressedHandler, removeVisibilityChangeHandler, removeVisualElement, removeVisualSetChangeHandler, 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.types.IAbstractChartVisualSet

addVisualSetChangeHandler, getContents, getMaxArgument, getMinArgument, getName, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementsCount, isMouseTransparent, removeVisibilityChangeHandler, removeVisualSetChangeHandler

Methods inherited from interface com.amalgamasimulation.visualsets.IUpdatePolicyPropertyOwner

getUpdatePolicy

Constructor Details

PolylineVisualSet

public PolylineVisualSet(String name,
 Supplier<List<T>> dataElementsProvider,
 Function<T,Double> beginArgumentExtractor,
 Function<T,Double> valueExtractor)

Constructs a PolylineVisualSet 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

beginArgumentExtractor - 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

setTooltipText

public PolylineVisualSet<T> setTooltipText(Function<T,String> tooltipText)

Description copied from class: VisualSet

Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.

Overrides:

setTooltipText in class AbstractPolylineVisualSet<T>

Parameters:

tooltipText - a function that specifies the rule for extracting a tooltip text from a data element

Returns:

reference to this object

setLineColor

public PolylineVisualSet<T> setLineColor(Color color)

Description copied from class: AbstractLineVisualSet

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

Overrides:

setLineColor in class AbstractLineVisualSet<T>

Parameters:

color - the line color of the plot

Returns:

reference to this object

setLineWidth

public PolylineVisualSet<T> setLineWidth(double width)

Description copied from class: AbstractLineVisualSet

Sets the width of the line, in pixels.

Overrides:

setLineWidth in class AbstractLineVisualSet<T>

Parameters:

width - the width of the line, in pixels

Returns:

reference to this object

setPointSize

public PolylineVisualSet<T> setPointSize(double pointSize)

Description copied from class: AbstractLineVisualSet

Sets the diameter of the point, in pixels.

Overrides:

setPointSize in class AbstractLineVisualSet<T>

Parameters:

pointSize - the diameter of the point, in pixels

Returns:

reference to this object

setPointsAndLinesStyle

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

Description copied from class: AbstractLineVisualSet

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

Overrides:

setPointsAndLinesStyle in class AbstractLineVisualSet<T>

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

setUpdatePolicy

public PolylineVisualSet<T> setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)

Description copied from interface: IAbstractChartVisualSet

Sets the new VisualSet.UpdatePolicy i.e. the VisualSet update control rule.

Specified by:

setUpdatePolicy in interface IAbstractChartVisualSet

Specified by:

setUpdatePolicy in interface IUpdatePolicyPropertyOwner

Overrides:

setUpdatePolicy in class VisualSet<T>

Parameters:

updatePolicy - new VisualSet.UpdatePolicy i.e. the VisualSet update control rule

Returns:

reference to this object

setLineStyle

public PolylineVisualSet<T> setLineStyle(LineStyle lineStyle)

Description copied from class: AbstractLineVisualSet

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

Overrides:

setLineStyle in class AbstractLineVisualSet<T>

Parameters:

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

Returns:

reference to this object

setMaxValue

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

Description copied from class: AbstractLineVisualSet

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.

Overrides:

setMaxValue in class AbstractLineVisualSet<T>

Parameters:

maxValueProvider - the supplier of max value

Returns:

reference to this object

setClipboardText

public PolylineVisualSet<T> setClipboardText(Function<Double,String> clipboardText)

Description copied from interface: IClipboardTextPropertyOwner

Sets the conversion method from values of each plot data element into text that will be copied to clipboard.

Specified by:

setClipboardText in interface IClipboardTextPropertyOwner<T>

Overrides:

setClipboardText in class AbstractPolylineVisualSet<T>

Parameters:

clipboardText - an extractor that converts the value of each plot data element into text that will be copied to the clipboard

Returns:

reference to this object

addContextMenuHandler

public PolylineVisualSet<T> addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)

Description copied from class: VisualSet

Adds the action to be executed every time a context menu for given data element is called.

Overrides:

addContextMenuHandler in class VisualSet<T>

Parameters:

contextMenuHandler - context menu call action

Returns:

reference to this object

addMouseEnterHandler

public PolylineVisualSet<T> addMouseEnterHandler(BiConsumer<T,MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time mouse enters to any visual element borders.

Overrides:

addMouseEnterHandler in class VisualSet<T>

Parameters:

handler - new mouse enter action

Returns:

reference to this object

addMouseExitHandler

public PolylineVisualSet<T> addMouseExitHandler(BiConsumer<T,MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time the mouse exits the previously entered element's bounds.

Overrides:

addMouseExitHandler in class VisualSet<T>

Parameters:

handler - new mouse exit action

Returns:

reference to this object

addMousePressedHandler

public PolylineVisualSet<T> addMousePressedHandler(BiConsumer<T,MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time a mouse button is pressed.

Overrides:

addMousePressedHandler in class VisualSet<T>

Parameters:

handler - new mouse button pressed action

Returns:

reference to this object

addVisibilityChangeHandler

public PolylineVisualSet<T> addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)

Description copied from interface: IAbstractChartVisualSet

Adds the action to be executed every time the visibility of this VisualSet is changed.

Specified by:

addVisibilityChangeHandler in interface IAbstractChartVisualSet

Overrides:

addVisibilityChangeHandler in class VisualSet<T>

Parameters:

visibilityChangeHandler - visibility change action

Returns:

reference to this object

setMouseTransparent

public PolylineVisualSet<T> setMouseTransparent(boolean mouseTransparent)

Description copied from interface: IAbstractChartVisualSet

Sets the value of the property mouseTransparent. If true, this VisualSet is completely transparent to mouse events. When choosing target for mouse event, VisualSets with mouseTransparent set to true won't be taken into account.

Specified by:

setMouseTransparent in interface IAbstractChartVisualSet

Overrides:

setMouseTransparent in class VisualSet<T>

Parameters:

mouseTransparent - new value of property mouseTransparent

Returns:

reference to this object

setLegendText

public PolylineVisualSet<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

Overrides:

setLegendText in class AbstractLineVisualSet<T>

Parameters:

legendTextProvider - the legend label text represents this visual set

Returns:

reference to this object

setExtrapolation

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

Description copied from class: AbstractLineVisualSet

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.

Overrides:

setExtrapolation in class AbstractLineVisualSet<T>

Parameters:

extrapolation - the AbstractLineVisualSet.Extrapolation of the plot

Returns:

reference to this object

getVisualElements

public List<PolylineVisualSet<T>.PolylineVisualElement> getVisualElements(boolean recalculationRequired)

Description copied from interface: IAbstractChartVisualSet

Returns the list of visual elements corresponding to current data elements. Cannot be changed by the user.

Specified by:

getVisualElements in interface IAbstractChartVisualSet

Specified by:

getVisualElements in interface ILineChartVisualSet

Overrides:

getVisualElements in class VisualSet<T>

Parameters:

recalculationRequired - flag of the need to recalculate the visual elements

Returns:

the list of visual elements corresponding to current data elements

getInjectionIndex

protected int getInjectionIndex(List<VisualSet<T>.VisualElement> list,
 VisualSet<T>.VisualElement element,
 T contents,
 int contentsIndex,
 Map<VisualSet<T>.VisualElement,Double> beginArgumentsCache)

Overrides:

getInjectionIndex in class AbstractPolylineVisualSet<T>

createVisualElement

public PolylineVisualSet<T>.PolylineVisualElement createVisualElement(T contents)

Description copied from class: VisualSet

Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.

Overrides:

createVisualElement in class AbstractPolylineVisualSet<T>

Parameters:

contents - data element for which the VisualSet<T>.VisualElement is being checked

Returns:

a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type