ilog.views.chart.datax.flat.list

Class IlvPropertyBasedFlatListModel

java.lang.Object

ilog.views.chart.datax.flat.list.IlvAbstractFlatListModel

ilog.views.chart.datax.flat.list.IlvBasicFlatListModel

ilog.views.chart.datax.flat.list.IlvDefaultFlatListModel

ilog.views.chart.datax.flat.list.IlvPropertyBasedFlatListModel

All Implemented Interfaces:

IlvFlatListModel, IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvBatchable, Cloneable

Direct Known Subclasses:

IlvListToFlatListModel

public class IlvPropertyBasedFlatListModel
extends IlvDefaultFlatListModel

This class is an implementation of the IlvFlatListModel 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.flat.list.IlvFlatListModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvPropertyBasedFlatListModel(Collection objects, IlvPropertyConnector propaccess, IlvDataColumnInfo[] columns) Creates a model with the given objects and the given columns.
IlvPropertyBasedFlatListModel(IlvPropertyConnector propaccess) Creates an empty model, with zero columns.
IlvPropertyBasedFlatListModel(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.
protected ilog.views.chart.datax.flat.internal.storage.IlvColumnStorage	createColumnStorage(IlvDataColumnInfo column) Creates the backing storage for a column value.
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 void	internalObjectsAdd(int index, Object object) Adds an object to the list of objects internally stored in this model.
protected void	internalObjectsRemove(int index) Removes an object from the list of objects internally stored in this model.
protected void	internalObjectsSet(int index, Object object) Replaces an object in the list of objects internally stored in this model.
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.flat.list.IlvDefaultFlatListModel

addObject, addObject, clear, getIndexOf, getObjectAt, getObjects, insertObject, insertObject, insertObjects, isColumnComputed, removeObject, removeObjects, setDoubleAt, setObjects, setValueAt

Methods inherited from class ilog.views.chart.datax.flat.list.IlvBasicFlatListModel

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

Methods inherited from class ilog.views.chart.datax.flat.list.IlvAbstractFlatListModel

addFlatListModelListener, convertToDouble, endBatch, removeFlatListModelListener, startBatch

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPropertyBasedFlatListModel

public IlvPropertyBasedFlatListModel(IlvPropertyConnector propaccess)

Creates an empty model, with zero columns.

IlvPropertyBasedFlatListModel

public IlvPropertyBasedFlatListModel(IlvPropertyConnector propaccess,
                                     IlvDataColumnInfo[] columns)

Creates an empty model, with the given columns.

IlvPropertyBasedFlatListModel

public IlvPropertyBasedFlatListModel(Collection objects,
                                     IlvPropertyConnector propaccess,
                                     IlvDataColumnInfo[] columns)

Creates a model with the given objects and 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 IlvFlatListModel

Specified by:

getValueAt in interface IlvObjectModelWithColumns

Overrides:

getValueAt in class IlvDefaultFlatListModel

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 IlvFlatListModel

Specified by:

getDoubleAt in interface IlvObjectModelWithColumns

Overrides:

getDoubleAt in class IlvDefaultFlatListModel

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, specifying whether the given value is different from the previous one.

Overrides:

setValueAtInternal in class IlvDefaultFlatListModel

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, specifying whether the given value is different from the previous one.

Overrides:

setDoubleAtInternal in class IlvDefaultFlatListModel

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

Specified by:

getSupportedEventsMask in interface IlvFlatListModel

Overrides:

getSupportedEventsMask in class IlvDefaultFlatListModel

See Also:

IlvFlatListModel.BEFORE_DATA_CHANGE_MASK, IlvFlatListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvFlatListModel.BEFORE_COLUMN_REMOVED_MASK

internalObjectsAdd

protected void internalObjectsAdd(int index,
                                  Object object)

Adds an object to the list of objects internally stored in this model.

Overrides:

internalObjectsAdd in class IlvDefaultFlatListModel

internalObjectsRemove

protected void internalObjectsRemove(int index)

Removes an object from the list of objects internally stored in this model.

Overrides:

internalObjectsRemove in class IlvDefaultFlatListModel

internalObjectsSet

protected void internalObjectsSet(int index,
                                  Object object)

Replaces an object in the list of objects internally stored in this model.

Overrides:

internalObjectsSet in class IlvDefaultFlatListModel

createColumnStorage

protected ilog.views.chart.datax.flat.internal.storage.IlvColumnStorage createColumnStorage(IlvDataColumnInfo column)

Creates the backing storage for a column value. This method can return null if the methods getValueAt and getDoubleAt do not need backing store.

Overrides:

createColumnStorage in class IlvDefaultFlatListModel

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 IlvDefaultFlatListModel

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 IlvBasicFlatListModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvDefaultFlatListModel