com.github.ptitnoony.components.fxtreemap

Interface MapData

All Known Implementing Classes:

AggredatedData, SimpleMapData

public interface MapData

Author:

ahamon

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.

Method Detail

getValue

double getValue()

Get the data value.

Returns:

the data value

setValue

void setValue(double newValue)

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.

Parameters:

newValue - the new data value

getName

String getName()

Get the data name.

Returns:

the data name

setName

void setName(String newName)

Set the data name.

Parameters:

newName - the new data name

hasChildrenData

boolean hasChildrenData()

If the data is an aggregation of children data.

Returns:

if the data is an aggregation of children data

getChildrenData

List<MapData> getChildrenData()

Get the children aggregated data if any.

Returns:

the list of aggregated data

addChildrenData

void addChildrenData(MapData data)

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

Parameters:

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

removeChildrenData

void removeChildrenData(MapData data)

Remove a child data.

Parameters:

data - the data to be removed