com.github.ptitnoony.components.fxtreemap

Class AggredatedData

java.lang.Object

com.github.ptitnoony.components.fxtreemap.AggredatedData

All Implemented Interfaces:

MapData

public class AggredatedData
extends Object
implements MapData

Author:

ahamon

Constructor Summary

Constructors

Constructor and Description
AggredatedData() Creates a new AggredatedData with TreeMapUtils.DEFAULT_DATA_VALUE.
AggredatedData(String dataCollectionName) Creates a new AggredatedData with TreeMapUtils.DEFAULT_DATA_VALUE.
AggredatedData(String dataCollectionName, List<MapData> dataElements) Creates an aggregated data from the given list of MapData.
AggredatedData(String dataCollectionName, MapData... dataElements) Creates an aggregated data from the given data elements.

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

AggredatedData

public AggredatedData(String dataCollectionName,
                      List<MapData> dataElements)

Creates an aggregated data from the given list of MapData.

Parameters:

dataCollectionName - the data name

dataElements - list containing data to be aggregated as children

AggredatedData

public AggredatedData(String dataCollectionName,
                      MapData... dataElements)

Creates an aggregated data from the given data elements.

Parameters:

dataCollectionName - the data name

dataElements - the data elements to be added as children

AggredatedData

public AggredatedData(String dataCollectionName)

Creates a new AggredatedData with TreeMapUtils.DEFAULT_DATA_VALUE.

Parameters:

dataCollectionName - the data name

AggredatedData

public AggredatedData()

Creates a new AggredatedData with TreeMapUtils.DEFAULT_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