Package com.storedobject.svg.chart

Class Values

java.lang.Object

com.storedobject.svg.chart.Values

All Implemented Interfaces:

Serializable

public class Values
extends Object
implements Serializable

This class represents a collection of data values to be plotted on a chart. It handles labels, values, units, colors, and basic formatting.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Values.StyledValue	Represents a value with associated styles.
static class	Values.Value	Represents a single data point in the chart.

Constructor Summary

Constructors

Constructor	Description
Values()	Constructor.
Values(String unit)	Constructor with a unit.

Method Summary

Modifier and Type	Method	Description
Values.Value	add(Values.Value value)	Add a Values.Value to the collection.
Values.Value	add(Object label, double value)	Add a value with a label.
String	buildStyles(Node node)	Builds and returns the styles associated with all values in the collection.
void	clear()	Clear all values.
void	colorize()	Automatically assign colors to values that don't have one.
Values.Value	get(int index)	Get the value at a specific index.
String	getColor(Values.Value value)	Get the color for a given Values.Value.
String	getLabel(Values.Value value)	Get the formatted label for a given Values.Value.
String	getLabelName()	Get the label name.
String	getLabelNameColor()	Get the color for the label name.
double	getPercentage(Values.Value value)	Get the percentage of a given Values.Value relative to the total.
String	getPercentageString(Values.Value value)	Get the percentage string for a given Values.Value.
double	getTotal()	Get the total sum of all values.
String	getUnit()	Get the unit.
String	getValue(Values.Value value)	Get the formatted value for a given Values.Value.
String	getValueName()	Get the value name.
String	getValueNameColor()	Get the color for the value name.
boolean	isBuilt()	Check if the values are built.
List<Values.Value>	list()	Get the list of values.
void	remove(Values.Value value)	Remove a Values.Value from the collection.
void	remove(Object label)	Remove values with a specific label.
void	setDefaultValueColor(String defaultValueColor)	Set the default color for values.
void	setLabelFunction(Function<Values.Value,String> labelFunction)	Set the function to generate labels for Values.Value objects.
void	setLabelName(String labelName)	Set the label name (typically used as an X-axis name).
void	setLabelNameColor(String labelNameColor)	Set the color for the label name.
void	setUnit(String unit)	Set the unit for values.
void	setValueFunction(Function<Values.Value,String> valueFunction)	Set the function to generate formatted value strings for Values.Value objects.
void	setValueName(String valueName)	Set the value name (typically used as a Y-axis name).
void	setValueNameColor(String valueNameColor)	Set the color for the value name.
int	size()	Get the number of values.
Stream<Values.Value>	stream()	Get a stream of values.
static String	toString(double v, String unit)	Convert a double to string with unit.
String	toUnit(double v)	Format a double value with its unit.
String	toUnit(Values.Value v)	Format a Values.Value with its unit.

Methods inherited from class java.lang.Object

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

Constructor Details

Values

public Values()

Constructor.

Values

public Values(String unit)

Constructor with a unit.

Parameters:

unit - Unit to be used for values.

Method Details

setUnit

public void setUnit(String unit)

Set the unit for values.

Parameters:

unit - Unit to be set.

getUnit

public String getUnit()

Get the unit.

Returns:

Current unit.

setLabelName

public void setLabelName(String labelName)

Set the label name (typically used as an X-axis name).

Parameters:

labelName - Label name.

getLabelName

public String getLabelName()

Get the label name.

Returns:

Label name.

setValueNameColor

public void setValueNameColor(String valueNameColor)

Set the color for the value name.

Parameters:

valueNameColor - Color to set.

getValueNameColor

public String getValueNameColor()

Get the color for the value name.

Returns:

Color.

setLabelNameColor

public void setLabelNameColor(String labelNameColor)

Set the color for the label name.

Parameters:

labelNameColor - Color to set.

getLabelNameColor

public String getLabelNameColor()

Get the color for the label name.

Returns:

Color.

setValueName

public void setValueName(String valueName)

Set the value name (typically used as a Y-axis name).

Parameters:

valueName - Value name.

getValueName

public String getValueName()

Get the value name.

Returns:

Value name.

getValue

public String getValue(Values.Value value)

Get the formatted value for a given Values.Value.

Parameters:

value - Value object.

Returns:

Formatted value string.

getLabel

public String getLabel(Values.Value value)

Get the formatted label for a given Values.Value.

Parameters:

value - Value object.

Returns:

Formatted label string.

setDefaultValueColor

public void setDefaultValueColor(String defaultValueColor)

Set the default color for values.

Parameters:

defaultValueColor - Color to set.

getColor

public String getColor(Values.Value value)

Get the color for a given Values.Value.

Parameters:

value - Value object.

Returns:

Color string.

setLabelFunction

public void setLabelFunction(Function<Values.Value,String> labelFunction)

Set the function to generate labels for Values.Value objects.

Parameters:

labelFunction - Label function.

setValueFunction

public void setValueFunction(Function<Values.Value,String> valueFunction)

Set the function to generate formatted value strings for Values.Value objects.

Parameters:

valueFunction - Value function.

getTotal

public double getTotal()

Get the total sum of all values.

Returns:

Total sum.

getPercentage

public double getPercentage(Values.Value value)

Get the percentage of a given Values.Value relative to the total.

Parameters:

value - Value object.

Returns:

Percentage.

getPercentageString

public String getPercentageString(Values.Value value)

Get the percentage string for a given Values.Value.

Parameters:

value - Value object.

Returns:

Percentage string (e.g., "50.0%").

add

public Values.Value add(Values.Value value)

Add a Values.Value to the collection.

Note: The added value object is returned for convenience. However, it could be different from the input value if it needs to be modified to adjust its properties.

Parameters:

value - Value object to add.

Returns:

Added value object.

add

public Values.Value add(Object label,
 double value)

Add a value with a label.

Parameters:

label - Label for the value.

value - Value.

Returns:

Added value object.

remove

public void remove(Values.Value value)

Remove a Values.Value from the collection.

Parameters:

value - Value object to remove.

remove

public void remove(Object label)

Remove values with a specific label.

Parameters:

label - Label of the values to remove.

clear

public void clear()

Clear all values.

stream

public Stream<Values.Value> stream()

Get a stream of values.

Returns:

Stream of Values.Value objects.

list

public List<Values.Value> list()

Get the list of values.

Returns:

List of Values.Value objects.

get

public Values.Value get(int index)

Get the value at a specific index.

Parameters:

index - Index.

Returns:

Value at the index.

size

public int size()

Get the number of values.

Returns:

Size.

toUnit

public String toUnit(Values.Value v)

Format a Values.Value with its unit.

Parameters:

v - Value object.

Returns:

Formatted string.

toUnit

public String toUnit(double v)

Format a double value with its unit.

Parameters:

v - Value.

Returns:

Formatted string.

toString

public static String toString(double v,
 String unit)

Convert a double to string with unit.

Parameters:

v - Value.

unit - Unit.

Returns:

Formatted string.

isBuilt

public boolean isBuilt()

Check if the values are built.

Returns:

True if built.

colorize

public void colorize()

Automatically assign colors to values that don't have one.

buildStyles

public String buildStyles(Node node)

Builds and returns the styles associated with all values in the collection. Only values that are instances of StyledValue are processed, and their individual styles are appended to the result.

Parameters:

node - The SVG where the styles are being used.

Returns:

A concatenated string of styles for all StyledValue objects in the collection.