com.jidesoft.treemap
Interface TreeMapNode<N extends TreeMapNode<N>>

All Known Subinterfaces:

MutableTreeMapNode<N>

All Known Implementing Classes:

AbstractTreeMapNode

public interface TreeMapNode<N extends TreeMapNode<N>>

Interface representing an object that can be placed in a treemap layout.

Method Summary

Object	getAggregateValue(int columnIndex) Gets the aggregate value of the children of this node.
Rectangle2D	getBounds() Gets the bounding rectangle of the item in the map.
TreeMapField<N>	getChildrenGroupByField() Returns the number of levels above this node -- the distance from the root to this node.
TreeMapField<N>	getGroupByField() Returns the number of levels above this node -- the distance from the root to this node.
int	getLevel() Returns the number of levels above this node -- the distance from the root to this node.
Shape	getShape() Gets the shape of the item in the map.
double	getSize() Corresponds to area in map.
boolean	isLeaf() Tells whether this node contains children.

Method Detail

getSize

double getSize()

Corresponds to area in map.

Returns:

the area

getShape

Shape getShape()

Gets the shape of the item in the map.

Returns:

the shape of the item in the map.

getBounds

Rectangle2D getBounds()

Gets the bounding rectangle of the item in the map.

Returns:

the bounding rectangle of the item in the map.

getLevel

int getLevel()

Returns the number of levels above this node -- the distance from the root to this node. If this node is the root, returns 0.

Returns:

the number of levels above this node

getGroupByField

TreeMapField<N> getGroupByField()

Returns the number of levels above this node -- the distance from the root to this node. If this node is the root, returns 0.

Returns:

the number of levels above this node

getChildrenGroupByField

TreeMapField<N> getChildrenGroupByField()

Returns the number of levels above this node -- the distance from the root to this node. If this node is the root, returns 0.

Returns:

the number of levels above this node

isLeaf

boolean isLeaf()

Tells whether this node contains children.

Returns:

true if this node contains children, false otherwise

getAggregateValue

Object getAggregateValue(int columnIndex)

Gets the aggregate value of the children of this node.

Parameters:

columnIndex - the column

Returns:

the aggregate value