com.jidesoft.treemap
Interface TreeMapModel<N>

Type Parameters:

N - the type of nodes

All Known Implementing Classes:

AbstractTreeMapModel, DefaultTreeMapModel

public interface TreeMapModel<N>

Main interface for the model part of TreeMap.

Field Summary

static String

PROPERTY_PROGRESS

Method Summary

void	addListener(TreeMapListener treeMapListener) Add a listener for receiving interesting events about changes in the model.
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Iterable<N>	breadthFirstIterator(N parent) Creates and returns an iterable that traverses the subhierarchy rooted at the give node in breadth-first order.
MutableColorMap	createDefaultColorMap(TreeMapField field)
Iterable<N>	depthFirstIterator(N parent) Creates and returns an iterable that traverses the subhierarchy rooted at the give node in depth-first order.
ComboBoxModel	getBackgroundModel()
Rectangle2D	getBounds(N node) Gets the bounding rectangle of the item in the map.
int	getChildCount(N node) Returns the number of children of a given node.
Iterable<N>	getChildren(N parent) Returns an iterator of the children of the given node.
TreeMapField<N>	getChildrenGroupByField(N node) Gets the depth in hierarchy.
Color	getColor(N node) Gets the color of the given node.
ComboBoxModel	getColorModel()
Class<?>	getColumnClass(int columnIndex) Returns the most specific superclass for all the cell values in the column.
int	getColumnCount() Returns the number of columns in the model.
String	getColumnName(int columnIndex) Returns the name of the column at columnIndex.
N	getCurrentRoot() Gets the currently selected root node from which the treemap should be displayed.
Color	getCushionColor(N node) Returns the color of the cushion.
BufferedImage	getCushionImage(N node) Returns the image used for painting the cushion.
MutableValueFilter<N>	getFilter() Obtains the model used for filtering nodes in the treemap.
TreeMapField<N>	getGroupByField(N node) Gets the depth in hierarchy.
ComboBoxModel	getGroupByModel()
ComboBoxModel	getHeightModel()
List<N>	getHighlighting() Obtains the model used to highlight nodes in the treemap.
ComboBoxModel	getLabelModel()
String	getLabelName(N node) Gets the label of the given node.
int	getLevel(N node) Gets the depth in hierarchy.
N	getNode(Point p)
double	getNormalizedLightSourceX() Gets the the position of the light source along the X axis.
double	getNormalizedLightSourceY() Gets the the position of the light source along the Y axis.
double	getNormalizedLightSourceZ() Gets the the position of the light source along the Z axis.
Double	getNumericMax(TreeMapField columnIndex) Gets the maximum value contained in the specified column.
Double	getNumericMin(TreeMapField columnIndex) Gets the minimum value contained in the specified column.
N	getParent(N node) Gets the parent node of the given node.
N	getProbing() Obtains the model used for probing (aka mouse over).
N	getRoot() Returns the root node of the treemap.
MutableValueFilter<N>	getSearch() Obtains the model used to carry out search in the treemap.
List<N>	getSelection() Obtains the model used for selecting nodes in the treemap.
TreeMapSettings	getSettings() Gets the settings currently selected.
Shape	getShape(N node) Gets the shape of the item in the map.
double	getSize(N node) Corresponds to area in map.
ComboBoxModel	getSizeModel()
String	getStringValue(N node, TreeMapField field) Returns the string value for the cell at columnIndex and of node.
TreeMapField	getTreeMapField(int columnIndex) Gets the field corresponding to the specified column index.
TreeMapField	getTreeMapField(String columnName) Gets the field corresponding to the specified column name.
Object	getValueAt(N node, int columnIndex) Returns the value for the cell at columnIndex and of node.
TreeMapWorker	getWorker() Gets the worker task updating the layout.
Future<Void>	getWorkerFuture() Gets the worker task updating the layout.
boolean	isEveryValueUnique(TreeMapField<N> field) Indicates whether all the values in the given field are unique.
boolean	isLeaf(N node) Tells whether the given node is a leaf node or not.
boolean	isRoot(N node) Tells whether the given node is the root node or not.
Iterable<N>	preorderEnumeration(N parent) Creates and returns an iterable that traverses the subhierarchy rooted at the give node in preorder.
void	removeListener(TreeMapListener treeMapListener) Remove a listener from the list of listeners that should be notified about changes in the model.
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	setColor(N node, Color color) Sets the color of the given node.
void	setCurrentRoot(N currentRoot) Sets the currently selected root node from which the treemap should be displayed.
void	setHighlighting(List<N> highlighting)
void	setNumericMax(TreeMapField columnIndex, double max) Sets the maximum value contained in the specified column.
void	setNumericMin(TreeMapField columnIndex, double min) Sets the minimum value contained in the specified column.
void	setProbing(N n)
void	setSelection(List<N> selection)
void	setShape(N node, Shape shape) Sets the shape of the item in the map.

Field Detail

PROPERTY_PROGRESS

static final String PROPERTY_PROGRESS

See Also:

Constant Field Values

Method Detail

getSize

double getSize(N node)

Corresponds to area in map.

Parameters:

node - the node.

Returns:

the area

setShape

void setShape(N node,
              Shape shape)

Sets the shape of the item in the map.

Parameters:

node - the node.

shape - the shape of the item in the map.

getShape

Shape getShape(N node)

Gets the shape of the item in the map.

Parameters:

node - the node.

Returns:

the shape of the item in the map.

getBounds

Rectangle2D getBounds(N node)

Gets the bounding rectangle of the item in the map.

Parameters:

node - the node.

Returns:

the bounding rectangle of the item in the map.

getLevel

int getLevel(N node)

Gets the depth in hierarchy.

Parameters:

node - the node.

Returns:

the depth in hierarchy.

getGroupByField

TreeMapField<N> getGroupByField(N node)

Gets the depth in hierarchy.

Parameters:

node - the node.

Returns:

the depth in hierarchy.

getChildrenGroupByField

TreeMapField<N> getChildrenGroupByField(N node)

Gets the depth in hierarchy.

Parameters:

node - the node.

Returns:

the depth in hierarchy.

getLabelName

String getLabelName(N node)

Gets the label of the given node.

Parameters:

node - the node.

Returns:

its label.

setColor

void setColor(N node,
              Color color)

Sets the color of the given node.

Parameters:

node - the node.

color - its color.

getColor

Color getColor(N node)

Gets the color of the given node.

Parameters:

node - the node.

Returns:

its color.

createDefaultColorMap

MutableColorMap createDefaultColorMap(TreeMapField field)

isLeaf

boolean isLeaf(N node)

Tells whether the given node is a leaf node or not.

Parameters:

node - the node

Returns:

true if it is a leaf node, false otherwise.

getParent

N getParent(N node)

Gets the parent node of the given node.

Parameters:

node - the node

Returns:

its parent

isRoot

boolean isRoot(N node)

Tells whether the given node is the root node or not.

Parameters:

node - the node

Returns:

true if it is the root node, false otherwise.

getChildren

Iterable<N> getChildren(N parent)

Returns an iterator of the children of the given node.

Parameters:

parent - the parent node

Returns:

the children

getChildCount

int getChildCount(N node)

Returns the number of children of a given node.

Parameters:

node - the parent node.

Returns:

the number of children

getCushionImage

BufferedImage getCushionImage(N node)

Returns the image used for painting the cushion.

Parameters:

node - the node

Returns:

the cushion image

getCushionColor

Color getCushionColor(N node)

Returns the color of the cushion.

Parameters:

node - the node

Returns:

the cushion color

preorderEnumeration

Iterable<N> preorderEnumeration(N parent)

Creates and returns an iterable that traverses the subhierarchy rooted at the give node in preorder. The first node returned by the iterator's next() method is the given node.

Parameters:

parent - the root of the hierarchy to traverse

Returns:

an iterable that traverses the subtree rooted at this node in preorder.

breadthFirstIterator

Iterable<N> breadthFirstIterator(N parent)

Creates and returns an iterable that traverses the subhierarchy rooted at the give node in breadth-first order. The first node returned by the iterator's next() method is the given node.

Parameters:

parent - the root of the hierarchy to traverse

Returns:

an iterable that traverses the subtree rooted at this node in breadth-first order.

depthFirstIterator

Iterable<N> depthFirstIterator(N parent)

Creates and returns an iterable that traverses the subhierarchy rooted at the give node in depth-first order. The first node returned by the iterator's next() method is the leftmost leaf.

Parameters:

parent - the root of the hierarchy to traverse

Returns:

an iterable that traverses the subtree rooted at this node in depth-first order.

getTreeMapField

TreeMapField getTreeMapField(int columnIndex)

Gets the field corresponding to the specified column index.

Parameters:

columnIndex - the index of the column.

Returns:

the field.

getTreeMapField

TreeMapField getTreeMapField(String columnName)

Gets the field corresponding to the specified column name.

Parameters:

columnName - the name of the column.

Returns:

the field.

getNumericMax

Double getNumericMax(TreeMapField columnIndex)

Gets the maximum value contained in the specified column.

Parameters:

columnIndex - the index of the column.

Returns:

the maximum value.

getNumericMin

Double getNumericMin(TreeMapField columnIndex)

Gets the minimum value contained in the specified column.

Parameters:

columnIndex - the index of the column.

Returns:

the minimum value.

setNumericMax

void setNumericMax(TreeMapField columnIndex,
                   double max)

Sets the maximum value contained in the specified column.

Parameters:

columnIndex - the index of the column.

max - the maximum value.

setNumericMin

void setNumericMin(TreeMapField columnIndex,
                   double min)

Sets the minimum value contained in the specified column.

Parameters:

columnIndex - the index of the column.

min - the minimum value.

getNormalizedLightSourceX

double getNormalizedLightSourceX()

Gets the the position of the light source along the X axis.

Returns:

the position along the X axis.

getNormalizedLightSourceY

double getNormalizedLightSourceY()

Gets the the position of the light source along the Y axis.

Returns:

the position along the Y axis.

getNormalizedLightSourceZ

double getNormalizedLightSourceZ()

Gets the the position of the light source along the Z axis.

Returns:

the position along the Z axis.

getColumnCount

int getColumnCount()

Returns the number of columns in the model.

Returns:

the number of columns in the model

getColumnName

String getColumnName(int columnIndex)

Returns the name of the column at columnIndex. Note: this name does not need to be unique; two columns in a table can have the same name.

Parameters:

columnIndex - the index of the column

Returns:

the name of the column

getColumnClass

Class<?> getColumnClass(int columnIndex)

Returns the most specific superclass for all the cell values in the column.

Parameters:

columnIndex - the index of the column

Returns:

the common ancestor class of the object values in the model.

getValueAt

Object getValueAt(N node,
                  int columnIndex)

Returns the value for the cell at columnIndex and of node.

Parameters:

node - the node whose value is to be queried

columnIndex - the column whose value is to be queried

Returns:

the value Object at the specified cell

isEveryValueUnique

boolean isEveryValueUnique(TreeMapField<N> field)

Indicates whether all the values in the given field are unique.

Parameters:

field - the field whose whose values are to be queried

Returns:

true if every value is unique, false otherwise

getStringValue

String getStringValue(N node,
                      TreeMapField field)

Returns the string value for the cell at columnIndex and of node.

Parameters:

node - the node whose value is to be queried

field - the field whose value is to be queried

Returns:

the value Object at the specified cell

getRoot

N getRoot()

Returns the root node of the treemap.

Returns:

the root node.

setCurrentRoot

void setCurrentRoot(N currentRoot)

Sets the currently selected root node from which the treemap should be displayed.

Parameters:

currentRoot - the root node to use for display.

getCurrentRoot

N getCurrentRoot()

Gets the currently selected root node from which the treemap should be displayed.

Returns:

the currently selected root node.

getProbing

N getProbing()

Obtains the model used for probing (aka mouse over).

Returns:

the model used for probing.

setProbing

void setProbing(N n)

getHighlighting

List<N> getHighlighting()

Obtains the model used to highlight nodes in the treemap.

Returns:

the model used for highlighting.

setHighlighting

void setHighlighting(List<N> highlighting)

getSelection

List<N> getSelection()

Obtains the model used for selecting nodes in the treemap.

Returns:

the model used for selection.

setSelection

void setSelection(List<N> selection)

getFilter

MutableValueFilter<N> getFilter()

Obtains the model used for filtering nodes in the treemap.

Returns:

the model used for filtering.

getSearch

MutableValueFilter<N> getSearch()

Obtains the model used to carry out search in the treemap.

Returns:

the model used for searching.

getSettings

TreeMapSettings getSettings()

Gets the settings currently selected.

Returns:

the settings.

getGroupByModel

ComboBoxModel getGroupByModel()

getLabelModel

ComboBoxModel getLabelModel()

getBackgroundModel

ComboBoxModel getBackgroundModel()

getSizeModel

ComboBoxModel getSizeModel()

getHeightModel

ComboBoxModel getHeightModel()

getColorModel

ComboBoxModel getColorModel()

getWorker

TreeMapWorker getWorker()

Gets the worker task updating the layout.

Returns:

the worker task

getWorkerFuture

Future<Void> getWorkerFuture()

Gets the worker task updating the layout.

Returns:

the worker task

addListener

void addListener(TreeMapListener treeMapListener)

Add a listener for receiving interesting events about changes in the model.

Parameters:

treeMapListener - the listener to add.

removeListener

void removeListener(TreeMapListener treeMapListener)

Remove a listener from the list of listeners that should be notified about changes in the model.

Parameters:

treeMapListener - the listener to remove.

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                  PropertyChangeListener listener)

getNode

N getNode(Point p)