ilog.views.chart.datax.tree.set

Class IlvPropertyBasedTreeSetModel

java.lang.Object

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

ilog.views.chart.datax.tree.set.IlvBasicTreeSetModel

ilog.views.chart.datax.tree.set.IlvDefaultTreeSetModel

ilog.views.chart.datax.tree.set.IlvPropertyBasedTreeSetModel

All Implemented Interfaces:

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

public class IlvPropertyBasedTreeSetModel
extends IlvDefaultTreeSetModel

This class is an implementation of the IlvTreeSetModel interface which stores the objects and the column info objects locally in this instance. The values are assumed to be properties of the objects.

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
IlvPropertyBasedTreeSetModel(IlvPropertyConnector propaccess) Creates an empty model, with zero columns.
IlvPropertyBasedTreeSetModel(IlvPropertyConnector propaccess, IlvDataColumnInfo[] columns) Creates an empty model, with the given columns.

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a copy of this object.
void	disconnect() Drops references to objects to help garbage collection.
void	dispose() Cleans up this model and drops references to objects to help garbage collection.
double	getDoubleAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in 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.
Object	getValueAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
protected boolean	setDoubleAtInternal(double value, Object object, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
protected boolean	setValueAtInternal(Object value, Object object, int columnIndex, boolean forReal) Does the equivalent of a setValueAt().

Methods inherited from class ilog.views.chart.datax.tree.set.IlvDefaultTreeSetModel

addChild, addChildren, clear, getChildren, getParent, getPath, getRoot, removeAllChildren, removeChild, removeChildren, setChildren, setDoubleAt, setRoot, setValueAt

Methods inherited from class ilog.views.chart.datax.tree.set.IlvBasicTreeSetModel

addColumn, addColumn, fireModelEvent, getColumn, getColumnCount, getColumns, insertColumn, insertColumn, removeColumn, setColumn, setColumnCount, setColumns

Methods inherited from class ilog.views.chart.datax.tree.set.IlvAbstractTreeSetModel

addTreeSetModelListener, convertToDouble, endBatch, postOrderIterator, preOrderIterator, removeTreeSetModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPropertyBasedTreeSetModel

public IlvPropertyBasedTreeSetModel(IlvPropertyConnector propaccess)

Creates an empty model, with zero columns.

IlvPropertyBasedTreeSetModel

public IlvPropertyBasedTreeSetModel(IlvPropertyConnector propaccess,
                                    IlvDataColumnInfo[] columns)

Creates an empty model, with the given columns.

Method Detail

getValueAt

public Object getValueAt(Object object,
                         int columnIndex)

Returns the value for the attribute number columnIndex in the given object.

Specified by:

getValueAt in interface IlvObjectModelWithColumns

Specified by:

getValueAt in interface IlvTreeSetModel

Overrides:

getValueAt in class IlvDefaultTreeSetModel

Parameters:

object - The object (row) in which the value is to be looked up.

columnIndex - The column denoting the attribute whose value is to be looked up.

getDoubleAt

public double getDoubleAt(Object object,
                          int columnIndex)

Returns the value for the attribute number columnIndex in the given object.

This method should only be used for columns whose type is Double. For other types of columns, this method will do a conversion from the object returned by getValueAt, which may be inefficient or inaccurate or raise exceptions.

Specified by:

getDoubleAt in interface IlvObjectModelWithColumns

Specified by:

getDoubleAt in interface IlvTreeSetModel

Overrides:

getDoubleAt in class IlvDefaultTreeSetModel

Parameters:

object - The object (row) in which the value is to be looked up.

columnIndex - The column denoting the attribute whose value is to be looked up.

setValueAtInternal

protected boolean setValueAtInternal(Object value,
                                     Object object,
                                     int columnIndex,
                                     boolean forReal)

Does the equivalent of a setValueAt(). Instead of notifying it simply returns a boolean indicating whether notification should be done.

If forReal is false, the value is not actually set, but the method still returns the same Boolean, indicating whether the given value is different from the previous one.

Overrides:

setValueAtInternal in class IlvDefaultTreeSetModel

setDoubleAtInternal

protected boolean setDoubleAtInternal(double value,
                                      Object object,
                                      int columnIndex,
                                      boolean forReal)

Does the equivalent of a setDoubleAt(). Instead of notifying it simply returns a boolean indicating whether notification should be done.

If forReal is false, the value is not actually set, but the method still returns the same Boolean, indicating whether the given value is different from the previous one.

Overrides:

setDoubleAtInternal in class IlvDefaultTreeSetModel

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 BEFORE_OBJECTS_REMOVED_MASK | DURING_OBJECTS_REMOVED_MASK | BEFORE_COLUMN_REMOVED_MASK. It may need to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvTreeSetModel

Overrides:

getSupportedEventsMask in class IlvDefaultTreeSetModel

See Also:

IlvTreeSetModel.BEFORE_DATA_CHANGE_MASK, IlvTreeSetModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeSetModel.BEFORE_COLUMN_REMOVED_MASK

dispose

public void dispose()

Cleans up this model and drops references to objects to help garbage collection.

Note: After calling this function, this model is no longer functional.

Overrides:

dispose in class IlvDefaultTreeSetModel

disconnect

public void disconnect()

Drops references to objects to help garbage collection.

Note: After calling this function, and after some changes occurred in the underlying columns or in the contained objects, this model is no longer functional.

Overrides:

disconnect in class IlvBasicTreeSetModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvDefaultTreeSetModel