ilog.views.chart.datax.flat.table

Class IlvBasicFlatTableModel

java.lang.Object

ilog.views.chart.datax.flat.table.IlvAbstractFlatTableModel

ilog.views.chart.datax.flat.table.IlvBasicFlatTableModel

All Implemented Interfaces:

IlvFlatTableModel, IlvDataConverter, IlvModelWithColumns, IlvBatchable, Cloneable

Direct Known Subclasses:

IlvDataSourceToFlatTableModel, IlvDefaultFlatTableModel

public abstract class IlvBasicFlatTableModel
extends IlvAbstractFlatTableModel
implements Cloneable

This class is an implementation of the IlvFlatTableModel 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 values stored in the model or of their attributes.

In order to implement an IlvFlatTableModel where the attribute values are stored locally in each object, it is sufficient to create a subclass of IlvBasicFlatTableModel that defines the methods IlvFlatTableModel.getRowCount(), IlvFlatTableModel.getValueAt(int, int), setValueAtInternal(java.lang.Object, int, int, boolean). Defining the methods IlvFlatTableModel.getDoubleAt(int, int) and setDoubleAtInternal(double, int, int, boolean) can save the allocation of a Double object at each invocation. When the value of a table cell changes, the model should construct an appropriate FlatTableModelEvent and call IlvAbstractFlatTableModel.fireModelEvent(ilog.views.chart.datax.flat.table.event.FlatTableModelEvent).

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.flat.table.IlvFlatTableModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_ROWS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvBasicFlatTableModel() Creates an empty model with zero columns.
IlvBasicFlatTableModel(IlvDataColumnInfo[] columns) Creates a model with the given columns.
IlvBasicFlatTableModel(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, double[] data) Adds a column with given data to the model.
void	addColumn(IlvDataColumnInfo column, Object[] data) Adds a column with given data to the model.
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 column values.
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(FlatTableModelEvent 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, double[] data) Adds a column with given data to the model at a given index.
void	insertColumn(int columnIndex, IlvDataColumnInfo column, Object[] data) Adds a column with given data to the model at a given index.
protected boolean	isColumnComputed(int columnIndex) Returns true if setValueAtInternal and setDoubleAtInternal on a given column have no effect.
void	removeColumn(int columnIndex) Removes a column from the model.
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.
void	setDoubleAt(double value, int rowIndex, int columnIndex) Sets the value in the cell at columnIndex and rowIndex to the given value.
protected abstract boolean	setDoubleAtInternal(double value, int rowIndex, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
void	setValueAt(Object value, int rowIndex, int columnIndex) Sets the value in the cell at columnIndex and rowIndex to the given value.
protected abstract boolean	setValueAtInternal(Object value, int rowIndex, int columnIndex, boolean forReal) Does the equivalent of a setValueAt().

Methods inherited from class ilog.views.chart.datax.flat.table.IlvAbstractFlatTableModel

addFlatTableModelListener, convertToDouble, endBatch, removeFlatTableModelListener, 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.flat.table.IlvFlatTableModel

getDoubleAt, getRowCount, getValueAt

Constructor Detail

IlvBasicFlatTableModel

public IlvBasicFlatTableModel()

Creates an empty model with zero columns.

IlvBasicFlatTableModel

public IlvBasicFlatTableModel(int numColumns)

Creates a model with the given number of columns.

IlvBasicFlatTableModel

public IlvBasicFlatTableModel(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 IlvFlatTableModel

Specified by:

getColumnCount in interface IlvModelWithColumns

getColumn

public IlvDataColumnInfo getColumn(int columnIndex)

Returns metainformation about a column.

Specified by:

getColumn in interface IlvFlatTableModel

Specified by:

getColumn in interface IlvModelWithColumns

Parameters:

columnIndex - The column.

isColumnComputed

protected boolean isColumnComputed(int columnIndex)

Returns true if setValueAtInternal and setDoubleAtInternal on a given column have no effect.

setValueAtInternal

protected abstract boolean setValueAtInternal(Object value,
                                              int rowIndex,
                                              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.

setDoubleAtInternal

protected abstract boolean setDoubleAtInternal(double value,
                                               int rowIndex,
                                               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.

setValueAt

public void setValueAt(Object value,
                       int rowIndex,
                       int columnIndex)

Sets the value in the cell at columnIndex and rowIndex to the given value.

Specified by:

setValueAt in interface IlvFlatTableModel

Parameters:

value - The new value.

rowIndex - The row containing the cell whose value is to be changed.

columnIndex - The column containing the cell whose value is to be changed.

setDoubleAt

public void setDoubleAt(double value,
                        int rowIndex,
                        int columnIndex)

Sets the value in the cell at columnIndex and rowIndex to the given value.

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

Specified by:

setDoubleAt in interface IlvFlatTableModel

Parameters:

value - The new value.

rowIndex - The row containing the cell whose value is to be changed.

columnIndex - The column containing the cell whose value is to be changed.

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

Specified by:

getSupportedEventsMask in interface IlvFlatTableModel

Overrides:

getSupportedEventsMask in class IlvAbstractFlatTableModel

See Also:

IlvFlatTableModel.BEFORE_DATA_CHANGE_MASK, IlvFlatTableModel.BEFORE_ROWS_REMOVED_MASK, IlvFlatTableModel.BEFORE_COLUMN_REMOVED_MASK

fireModelEvent

public void fireModelEvent(FlatTableModelEvent event)

Notifies the listeners of a model event.

Overrides:

fireModelEvent in class IlvAbstractFlatTableModel

createColumnStorage

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

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

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 metainformation of this column.

addColumn

public void addColumn(IlvDataColumnInfo column,
                      Object[] data)

Adds a column with given data to the model.

Parameters:

column - The metainformation of this column.

data - The initial data of this column. This should be an array of at least getRowCount() elements. Unused if the column is a computed column.

addColumn

public void addColumn(IlvDataColumnInfo column,
                      double[] data)

Adds a column with given data to the model.

Parameters:

column - The metainformation of this column.

data - The initial data of this column. This should be an array of at least getRowCount() elements. Unused if the column is a computed column.

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 metainformation of this column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         Object[] 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 metainformation of this column.

data - The initial data of this column. This should be an array of at least getRowCount() elements. Unused if the column is a computed column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         double[] 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 metainformation of this column.

data - The initial data of this column. This should be an array of at least getRowCount() elements. Unused if the column is a computed column.

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:

An unmodifiable list of IlvDataColumnInfo.

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 IlvAbstractFlatTableModel