ilog.views.chart.datax.tree.set

Class IlvAbstractTreeSetModel

java.lang.Object

ilog.views.chart.datax.tree.set.IlvAbstractTreeSetModel

All Implemented Interfaces:

IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvTreeModelWithColumns, IlvTreeSetModel, IlvBatchable, Cloneable

Direct Known Subclasses:

IlvBasicTreeSetModel, IlvFilterTreeSetModel, IlvFlatSetToTreeSetModel, IlvTreeListToTreeSetModel

public abstract class IlvAbstractTreeSetModel
extends Object
implements IlvTreeSetModel, IlvDataConverter, Cloneable

This class is an implementation of the IlvTreeSetModel interface which handles the notification to listeners of the model.

However, it does not constrain the nature of the objects stored in the model or of their attributes.

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.tree.set.IlvTreeSetModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK, DURING_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvAbstractTreeSetModel() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addTreeSetModelListener(TreeSetModelListener listener) Adds a listener.
Object	clone() Returns a copy of this object.
double	convertToDouble(Object value) Converts an Object to a double.
void	endBatch() Terminates a group of modifications.
void	fireModelEvent(TreeSetModelEvent event) Notifies the listeners of a model event.
TreePath	getPath(Object object) Returns the path from the root to the given object.
int	getSupportedEventsMask() Returns a bit mask denoting the optional kinds of events that are guaranteed to be sent by this model to the registered listeners.
Iterator	postOrderIterator() Returns an iterator that visits each object once.
Iterator	preOrderIterator() Returns an iterator that visits each object once.
void	removeTreeSetModelListener(TreeSetModelListener listener) Removes a listener.
void	startBatch() Starts a group of modifications.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.chart.datax.tree.set.IlvTreeSetModel

getChildren, getColumn, getColumnCount, getDoubleAt, getRoot, getValueAt, setDoubleAt, setValueAt

Constructor Detail

IlvAbstractTreeSetModel

public IlvAbstractTreeSetModel()

Creates a new instance.

Method Detail

startBatch

public void startBatch()

Starts a group of modifications.

Specified by:

startBatch in interface IlvTreeSetModel

Specified by:

startBatch in interface IlvBatchable

fireModelEvent

public void fireModelEvent(TreeSetModelEvent event)

Notifies the listeners of a model event.

endBatch

public void endBatch()

Terminates a group of modifications.

Specified by:

endBatch in interface IlvTreeSetModel

Specified by:

endBatch in interface IlvBatchable

addTreeSetModelListener

public void addTreeSetModelListener(TreeSetModelListener listener)

Adds a listener. It will be notified each time a change in the data or in the column metainformation occurs.

Specified by:

addTreeSetModelListener in interface IlvTreeSetModel

removeTreeSetModelListener

public void removeTreeSetModelListener(TreeSetModelListener listener)

Removes a listener. Unregisters the given listener from the notification list.

Specified by:

removeTreeSetModelListener in interface IlvTreeSetModel

getSupportedEventsMask

public int getSupportedEventsMask()

Returns a bit mask denoting the optional kinds of events that are guaranteed to be sent by this model to the registered listeners.

This implementation returns 0. It ought to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvTreeSetModel

See Also:

IlvTreeSetModel.BEFORE_DATA_CHANGE_MASK, IlvTreeSetModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeSetModel.BEFORE_COLUMN_REMOVED_MASK

getPath

public TreePath getPath(Object object)

Returns the path from the root to the given object.

Note: This default implementation is quite inefficient. Starting at the first invocation of this method, it builds up a hash table mapping each object to its tree path. Subclasses should override this implementation, whenever a less memory hungry implementation is possible.

Specified by:

getPath in interface IlvTreeSetModel

Parameters:

object - An object in the model.

Returns:

A TreePath whose first component is getRoot() and whose last component is the given object.

preOrderIterator

public Iterator preOrderIterator()

Returns an iterator that visits each object once. For each object, it visits the children objects after the object itself.

postOrderIterator

public Iterator postOrderIterator()

Returns an iterator that visits each object once. For each object, it visits the children objects before the object itself.

convertToDouble

public double convertToDouble(Object value)

Converts an Object to a double. This method is used in getDoubleAt for columns that are not of type Double.

Specified by:

convertToDouble in interface IlvDataConverter

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class Object