Package com.amalgamasimulation.charts.visualsets

Class BoxAndWhiskerVisualSet<T>

java.lang.Object

com.amalgamasimulation.charts.visualsets.VisualSet<T>

com.amalgamasimulation.charts.visualsets.BoxAndWhiskerVisualSet<T>

Type Parameters:

T - the type of the data elements contained in the visual set

All Implemented Interfaces:

IUpdatePolicyPropertyOwner, IAbstractChartVisualSet

public class BoxAndWhiskerVisualSet<T>
extends VisualSet<T>

Represents a visual set for rendering Box-and-Whisker plots, which are used to visualize some distribution. This class supports customization of box colors, element names, mean values, and intervals.

Author:

Andrey Malykhanov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BoxAndWhiskerVisualSet.BoxAndWhiskerVisualElement

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

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

Field Summary

Fields inherited from class com.amalgamasimulation.charts.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
BoxAndWhiskerVisualSet(String name, Supplier<List<T>> dataElementsProvider)

Method Summary

Modifier and Type	Method	Description
BoxAndWhiskerVisualSet<T>.BoxAndWhiskerVisualElement	createVisualElement(T contents)	Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.
List<BoxAndWhiskerVisualSet<T>.BoxAndWhiskerVisualElement>	getVisualElements(boolean recalculationRequired)	Returns the list of visual elements corresponding to current data elements.
BoxAndWhiskerVisualSet<T>	setBackgroundColor(Function<T,Color> backgroundColorExtractor)
BoxAndWhiskerVisualSet<T>	setBoxInterval(Function<T,Interval> boxIntervalExtractor)
BoxAndWhiskerVisualSet<T>	setElementName(Function<T,String> elementNameExtractor)
BoxAndWhiskerVisualSet<T>	setMeanValue(Function<T,Double> meanValueExtractor)
BoxAndWhiskerVisualSet<T>	setTooltipText(Function<T,String> tooltipTextExtractor)	Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.
BoxAndWhiskerVisualSet<T>	setWhiskerInterval(Function<T,Interval> whiskerIntervalExtractor)

Methods inherited from class com.amalgamasimulation.charts.visualsets.VisualSet

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

Methods inherited from class java.lang.Object

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

Constructor Details

BoxAndWhiskerVisualSet

public BoxAndWhiskerVisualSet(String name,
 Supplier<List<T>> dataElementsProvider)

Method Details

getVisualElements

public List<BoxAndWhiskerVisualSet<T>.BoxAndWhiskerVisualElement> 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

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

setBackgroundColor

public BoxAndWhiskerVisualSet<T> setBackgroundColor(Function<T,Color> backgroundColorExtractor)

setElementName

public BoxAndWhiskerVisualSet<T> setElementName(Function<T,String> elementNameExtractor)

setMeanValue

public BoxAndWhiskerVisualSet<T> setMeanValue(Function<T,Double> meanValueExtractor)

setBoxInterval

public BoxAndWhiskerVisualSet<T> setBoxInterval(Function<T,Interval> boxIntervalExtractor)

setWhiskerInterval

public BoxAndWhiskerVisualSet<T> setWhiskerInterval(Function<T,Interval> whiskerIntervalExtractor)

setTooltipText

public BoxAndWhiskerVisualSet<T> setTooltipText(Function<T,String> tooltipTextExtractor)

Description copied from class: VisualSet

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

Specified by:

setTooltipText in class VisualSet<T>

Parameters:

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

Returns:

reference to this object

createVisualElement

public BoxAndWhiskerVisualSet<T>.BoxAndWhiskerVisualElement createVisualElement(T contents)

Description copied from class: VisualSet

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

Specified by:

createVisualElement in class VisualSet<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