ilog.views.chart.datax.tree.list

Class IlvBasicTreeListModel

java.lang.Object

ilog.views.chart.datax.tree.list.IlvAbstractTreeListModel

ilog.views.chart.datax.tree.list.IlvBasicTreeListModel

All Implemented Interfaces:

IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvTreeModelWithColumns, IlvTreeListModel, IlvBatchable, Cloneable

Direct Known Subclasses:

IlvDefaultTreeListModel

public abstract class IlvBasicTreeListModel
extends IlvAbstractTreeListModel
implements Cloneable

This class is an implementation of the IlvTreeListModel interface which handles the notification to listeners of the model and the management of the columns.

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

In order to implement an IlvTreeListModel where the attribute values are stored locally in each object, it is sufficient to create a subclass of IlvBasicTreeListModel that defines the methods IlvTreeListModel.getRoot(), IlvTreeListModel.getChildren(java.lang.Object), IlvTreeListModel.getValueAt(java.lang.Object, int), IlvTreeListModel.setValueAt(java.lang.Object, java.lang.Object, int). The definition of the methods IlvTreeListModel.getDoubleAt(java.lang.Object, int), IlvTreeListModel.setDoubleAt(double, java.lang.Object, int) can save the allocation of a Double object at each invocation. When the set of objects changes, or when the value of an attribute of an object changes, the model should construct an appropriate TreeListModelEvent and call IlvAbstractTreeListModel.fireModelEvent(ilog.views.chart.datax.tree.list.event.TreeListModelEvent).

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.tree.list.IlvTreeListModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK, DURING_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvBasicTreeListModel() Creates a model with zero columns.
IlvBasicTreeListModel(IlvDataColumnInfo[] columns) Creates a model with the given columns.
IlvBasicTreeListModel(int numColumns) Creates a model with the given number of columns.

Method Summary

Modifier and Type	Method and Description
void	addColumn(IlvDataColumnInfo column) Adds a column to the model.
void	addColumn(IlvDataColumnInfo column, Map data) Adds a column with given data to the model.
protected void	addColumnStorage(int columnIndex, int insertedColumnCount) Adds storage for new columns.
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.
void	fireModelEvent(TreeListModelEvent event) Notifies the listeners of a model event.
IlvDataColumnInfo	getColumn(int columnIndex) Returns metainformation about a column.
int	getColumnCount() Returns the number of columns in the model.
List<IlvDataColumnInfo>	getColumns() Returns the list of columns.
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.
void	insertColumn(int columnIndex, IlvDataColumnInfo column) Adds a column to the model at a given index.
void	insertColumn(int columnIndex, IlvDataColumnInfo column, Map data) Adds a column with given data to the model at a given index.
protected boolean	isColumnComputed(int columnIndex) Returns true if setValueAt and setDoubleAt on a given column have no effect.
void	removeColumn(int columnIndex) Removes a column from the model.
protected void	removeColumnStorage(int columnIndex, int removedColumnCount) Removes storage for columns that have been dropped.
void	setColumn(int i, IlvDataColumnInfo column) Replaces or adds a column.
void	setColumnCount(int columnCount) Sets the number of columns in the model.
void	setColumns(List<IlvDataColumnInfo> columns) Sets the list of columns.

Methods inherited from class ilog.views.chart.datax.tree.list.IlvAbstractTreeListModel

addTreeListModelListener, convertToDouble, endBatch, getPath, postOrderIterator, preOrderIterator, removeTreeListModelListener, startBatch

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.list.IlvTreeListModel

getChildren, getDoubleAt, getRoot, getValueAt, setDoubleAt, setValueAt

Constructor Detail

IlvBasicTreeListModel

public IlvBasicTreeListModel()

Creates a model with zero columns.

IlvBasicTreeListModel

public IlvBasicTreeListModel(int numColumns)

Creates a model with the given number of columns.

IlvBasicTreeListModel

public IlvBasicTreeListModel(IlvDataColumnInfo[] columns)

Creates a model with the given columns.

Method Detail

getColumnCount

public int getColumnCount()

Returns the number of columns in the model.

Valid column indices range from 0 to getColumnCount()-1 (inclusive).

Specified by:

getColumnCount in interface IlvModelWithColumns

Specified by:

getColumnCount in interface IlvTreeListModel

getColumn

public IlvDataColumnInfo getColumn(int columnIndex)

Returns metainformation about a column.

Specified by:

getColumn in interface IlvModelWithColumns

Specified by:

getColumn in interface IlvTreeListModel

Parameters:

columnIndex - The column.

isColumnComputed

protected boolean isColumnComputed(int columnIndex)

Returns true if setValueAt and setDoubleAt on a given column have no effect.

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_COLUMN_REMOVED_MASK. It ought to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvTreeListModel

Overrides:

getSupportedEventsMask in class IlvAbstractTreeListModel

See Also:

IlvTreeListModel.BEFORE_DATA_CHANGE_MASK, IlvTreeListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvTreeListModel.BEFORE_COLUMN_REMOVED_MASK

fireModelEvent

public void fireModelEvent(TreeListModelEvent event)

Notifies the listeners of a model event.

Overrides:

fireModelEvent in class IlvAbstractTreeListModel

addColumnStorage

protected void addColumnStorage(int columnIndex,
                                int insertedColumnCount)

Adds storage for new columns.

removeColumnStorage

protected void removeColumnStorage(int columnIndex,
                                   int removedColumnCount)

Removes storage for columns that have been dropped.

setColumnCount

public void setColumnCount(int columnCount)

Sets the number of columns in the model. If the new size is greater than the current size, new columns are added to the end of the model. If the new size is less than the current size, all columns at index columnCount and greater are discarded.

Parameters:

columnCount - the new number of columns

addColumn

public void addColumn(IlvDataColumnInfo column)

Adds a column to the model.

Parameters:

column - The meta information of this column.

addColumn

public void addColumn(IlvDataColumnInfo column,
                      Map data)

Adds a column with given data to the model.

Parameters:

column - The meta information of this column.

data - The initial data of this column. This should be a map that assigns a value to every object in this model.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column)

Adds a column to the model at a given index.

Parameters:

columnIndex - The new column desired index, must be >= 0 and <= getColumnCount().

column - The meta information of this column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         Map data)

Adds a column with given data to the model at a given index.

Parameters:

columnIndex - The new column desired index, must be >= 0 and <= getColumnCount().

column - The meta information of this column.

data - The initial data of this column. This should be a map that assigns a value to every object in this model.

removeColumn

public void removeColumn(int columnIndex)

Removes a column from the model.

Parameters:

columnIndex - The column index, must be >= 0 and < getColumnCount().

getColumns

public List<IlvDataColumnInfo> getColumns()

Returns the list of columns.

Returns:

A list of IlvDataColumnInfo that cannot be modified.

setColumns

public void setColumns(List<IlvDataColumnInfo> columns)

Sets the list of columns.

Parameters:

columns - A list of IlvDataColumnInfo.

setColumn

public void setColumn(int i,
                      IlvDataColumnInfo column)

Replaces or adds a column. This is equivalent to removeColumn(i) followed by insertColumn(i, column).

Parameters:

column - An IlvDataColumnInfo.

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.

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, this model is no longer functional.

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvAbstractTreeListModel