Package com.storedobject.chart

Class TreeData

java.lang.Object

com.storedobject.chart.TreeData

All Implemented Interfaces:

ComponentPart, ComponentProperty, TreeDataProvider

public class TreeData
extends Object
implements TreeDataProvider

An implementation of TreeDataProvider.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from interface com.storedobject.chart.TreeDataProvider

TreeDataProvider.Label

Constructor Summary

Constructors

Constructor	Description
TreeData(String name)	Constructor.
TreeData(String name, Number value)	Constructor.

Method Summary

Modifier and Type	Method	Description
TreeData	add(TreeData... treeData)	Add children.
TreeData	add(String name, Number value)	Create and add a child.
TreeData	get(int index)	Get the data at the given index.
Stream<? extends TreeDataProvider>	getChildren()	Get the child nodes.
final long	getId()	Each part should have a unique Id.
final TreeDataProvider.Label	getLabel(boolean create)	Get the label for this tree node.
final String	getName()	Get the name of this part.
int	getSerial()	Get the current serial number (Serial number used for internal purposes only).
final Number	getValue()	Get data value.
TreeData	remove(TreeData... treeData)	Remove children.
void	setLabel(TreeDataProvider.Label label)	Set the label.
void	setSerial(int serial)	Set a serial number (Serial number used for internal purposes only).
void	setValue(Number value)	Set the value for the tree-node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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.TreeDataProvider

encodeJSON, getItemStyle, validate

Constructor Details

TreeData

public TreeData(String name)

Constructor.

Parameters:

name - Name.

TreeData

public TreeData(String name,
 Number value)

Constructor.

Parameters:

name - Name.

value - Value.

Method Details

getName

public final String getName()

Description copied from interface: ComponentPart

Get the name of this part.

Specified by:

getName in interface ComponentPart

Returns:

Name

getValue

public final Number getValue()

Description copied from interface: TreeDataProvider

Get data value.

Specified by:

getValue in interface TreeDataProvider

Returns:

Value.

setValue

public void setValue(Number value)

Set the value for the tree-node.

Parameters:

value - Value to be set. Could be null.

getChildren

public Stream<? extends TreeDataProvider> getChildren()

Description copied from interface: TreeDataProvider

Get the child nodes.

Specified by:

getChildren in interface TreeDataProvider

Returns:

Child nodes as a stream.

getId

public final long getId()

Description copied from interface: ComponentPart

Each part should have a unique Id. (It can be a final variable and can be set by calling ID.newID().

Specified by:

getId in interface ComponentPart

Returns:

Unique Id.

setSerial

public void setSerial(int serial)

Description copied from interface: ComponentPart

Set a serial number (Serial number used for internal purposes only). The implementation of this method must be in such a way that the serial number set here must be returned by the ComponentPart.getSerial() method.

Specified by:

setSerial in interface ComponentPart

Parameters:

serial - Serial number to set.

getSerial

public int getSerial()

Description copied from interface: ComponentPart

Get the current serial number (Serial number used for internal purposes only). The serial number set by the ComponentPart.setSerial(int) method should be returned by this method.

Specified by:

getSerial in interface ComponentPart

Returns:

Current serial number.

add

public TreeData add(TreeData... treeData)

Add children.

Parameters:

treeData - Data to add to children.

Returns:

Self-reference.

add

public TreeData add(String name,
 Number value)

Create and add a child.

Parameters:

name - Name of the child.

value - Value for the child.

Returns:

Self-reference.

remove

public TreeData remove(TreeData... treeData)

Remove children.

Parameters:

treeData - Data to be removed from children.

Returns:

Self-reference.

get

public TreeData get(int index)

Get the data at the given index.

Parameters:

index - Index.

Returns:

Data at the given index. Returns null for out of bound indices.

getLabel

public final TreeDataProvider.Label getLabel(boolean create)

Description copied from interface: TreeDataProvider

Get the label for this tree node.

Specified by:

getLabel in interface TreeDataProvider

Parameters:

create - Whether to create it if not exists.

Returns:

Return the label.

setLabel

public void setLabel(TreeDataProvider.Label label)

Set the label.

Parameters:

label - Label to be set.