com.github.ptitnoony.components.fxtreemap

Class SimpleMapData

java.lang.Object

com.github.ptitnoony.components.fxtreemap.SimpleMapData

All Implemented Interfaces:

MapData

public class SimpleMapData
extends Object
implements MapData

Author:

ahamon

Constructor Summary

Constructors

Constructor and Description
SimpleMapData(double dataValue) Create a new SimpleMapData with the given value and an empty name.
SimpleMapData(String dataName, double dataValue) Create a new SimpleMapData with the given name and value.

Method Summary

Modifier and Type	Method and Description
void	addChildrenData(MapData data) Add a child data.
List<MapData>	getChildrenData() Get the children aggregated data if any.
String	getName() Get the data name.
double	getValue() Get the data value.
boolean	hasChildrenData() If the data is an aggregation of children data.
void	removeChildrenData(MapData data) Remove a child data.
void	setName(String newName) Set the data name.
void	setValue(double newValue) Set the data value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMapData

public SimpleMapData(String dataName,
                     double dataValue)

Create a new SimpleMapData with the given name and value.

Parameters:

dataName - the data name

dataValue - the data value

SimpleMapData

public SimpleMapData(double dataValue)

Create a new SimpleMapData with the given value and an empty name.

Parameters:

dataValue - the data value

Method Detail

getValue

public double getValue()

Description copied from interface: MapData

Get the data value.

Specified by:

getValue in interface MapData

Returns:

the data value

setValue

public void setValue(double newValue)

Description copied from interface: MapData

Set the data value. If the data has children data, their value will be set with the same percentage of the value they use to have before the setValue is applied. The value must be equal or greater to 0.

Specified by:

setValue in interface MapData

Parameters:

newValue - the new data value

getName

public String getName()

Description copied from interface: MapData

Get the data name.

Specified by:

getName in interface MapData

Returns:

the data name

setName

public void setName(String newName)

Description copied from interface: MapData

Set the data name.

Specified by:

setName in interface MapData

Parameters:

newName - the new data name

getChildrenData

public List<MapData> getChildrenData()

Description copied from interface: MapData

Get the children aggregated data if any.

Specified by:

getChildrenData in interface MapData

Returns:

the list of aggregated data

hasChildrenData

public boolean hasChildrenData()

Description copied from interface: MapData

If the data is an aggregation of children data.

Specified by:

hasChildrenData in interface MapData

Returns:

if the data is an aggregation of children data

addChildrenData

public void addChildrenData(MapData data)

Description copied from interface: MapData

Add a child data. If the data had no child before, adding a child data will override the previously set data value.

Specified by:

addChildrenData in interface MapData

Parameters:

data - the data to be added as a child data to aggregate

removeChildrenData

public void removeChildrenData(MapData data)

Description copied from interface: MapData

Remove a child data.

Specified by:

removeChildrenData in interface MapData

Parameters:

data - the data to be removed