ilog.views.chart.datax.flat.table

Class IlvBufferFlatTableModel

java.lang.Object

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

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

ilog.views.chart.datax.flat.table.IlvDefaultFlatTableModel

ilog.views.chart.datax.flat.table.IlvBufferFlatTableModel

All Implemented Interfaces:

IlvFlatTableModel, IlvDataConverter, IlvModelWithColumns, IlvBatchable, Cloneable

public class IlvBufferFlatTableModel
extends IlvDefaultFlatTableModel

This class implements an IlvFlatTableModel that buffers (caches) the data of a given IlvFlatTableModel. It is meant to be used when the access to the original IlvFlatTableModel is slow.

Changes in the underlying model are propagated to this model if and only if the isNotifying method returns true.

Note: This model supports adding and removing rows and columns if and only if the underlying IlvFlatTableModel is an instance of IlvDefaultFlatTableModel.

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
IlvBufferFlatTableModel(IlvFlatTableModel model) Creates a model that is fed by and caches the data of a given IlvFlatTableModel.

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.
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.
void	insertRow(int rowIndex, Object[] rowData) Adds a row to the model at a given index.
void	insertRows(int rowIndex, int count) Adds some rows 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.
boolean	isNotifying() Returns true when this model is a dynamically updated cache of the underlying model.
void	removeColumn(int columnIndex) Removes a column from the model.
void	removeRows(int rowIndex, int count) Removes some rows from the model.
void	setColumnCount(int columnCount) Sets the number of columns in the model.
protected boolean	setDoubleAtInternal(double value, int rowIndex, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
void	setNotifying(boolean dynamic) Determines whether this model is a dynamically updated cache of the underlying event (and therefore also sends events when the underlying model changes).
void	setRowCount(int rowCount) Sets the number of rows in the model.
protected 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.IlvDefaultFlatTableModel

addRow, addRow, getDoubleAt, getRowCount, getValueAt, insertRow, removeRow

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

addColumn, addColumn, addColumn, createColumnStorage, fireModelEvent, getColumn, getColumnCount, getColumns, setColumn, setColumns, setDoubleAt, 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

Constructor Detail

IlvBufferFlatTableModel

public IlvBufferFlatTableModel(IlvFlatTableModel model)

Creates a model that is fed by and caches the data of a given IlvFlatTableModel.

Method Detail

setValueAtInternal

protected 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.

Overrides:

setValueAtInternal in class IlvDefaultFlatTableModel

setDoubleAtInternal

protected 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.

Overrides:

setDoubleAtInternal in class IlvDefaultFlatTableModel

isColumnComputed

protected boolean isColumnComputed(int columnIndex)

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

Overrides:

isColumnComputed in class IlvBasicFlatTableModel

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

Specified by:

getSupportedEventsMask in interface IlvFlatTableModel

Overrides:

getSupportedEventsMask in class IlvDefaultFlatTableModel

See Also:

IlvFlatTableModel.BEFORE_DATA_CHANGE_MASK, IlvFlatTableModel.BEFORE_ROWS_REMOVED_MASK, IlvFlatTableModel.BEFORE_COLUMN_REMOVED_MASK

setRowCount

public void setRowCount(int rowCount)

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

Overrides:

setRowCount in class IlvDefaultFlatTableModel

Parameters:

rowCount - The new number of rows.

insertRows

public void insertRows(int rowIndex,
                       int count)

Adds some rows to the model at a given index.

Overrides:

insertRows in class IlvDefaultFlatTableModel

Parameters:

rowIndex - The first new row desired index, must be >= 0 and <= getRowCount().

count - The number of rows to be inserted.

insertRow

public void insertRow(int rowIndex,
                      Object[] rowData)

Adds a row to the model at a given index.

Overrides:

insertRow in class IlvDefaultFlatTableModel

Parameters:

rowIndex - The new row desired index, must be >= 0 and <= getRowCount().

rowData - The initial data of this row, must be an array of getColumnCount() elements.

removeRows

public void removeRows(int rowIndex,
                       int count)

Removes some rows from the model.

Overrides:

removeRows in class IlvDefaultFlatTableModel

Parameters:

rowIndex - The first old row index, must be >= 0 and <= getRowCount() - count.

count - The number of rows to be removed.

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.

Overrides:

setColumnCount in class IlvBasicFlatTableModel

Parameters:

columnCount - The new number of columns.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column)

Adds a column to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatTableModel

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.

Overrides:

insertColumn in class IlvBasicFlatTableModel

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.

Overrides:

insertColumn in class IlvBasicFlatTableModel

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.

Overrides:

removeColumn in class IlvBasicFlatTableModel

Parameters:

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

isNotifying

public boolean isNotifying()

Returns true when this model is a dynamically updated cache of the underlying model. Returns false when this model is a snapshot buffer of the underlying model.

See Also:

setNotifying(boolean)

setNotifying

public void setNotifying(boolean dynamic)

Determines whether this model is a dynamically updated cache of the underlying event (and therefore also sends events when the underlying model changes).

Note: Calling setNotifying(true) after notification was turned off has the effect of bringing the entire cache up to date; this can be an expensive operation.

See Also:

isNotifying()

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 IlvBasicFlatTableModel

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

Overrides:

disconnect in class IlvBasicFlatTableModel

Since:

JViews 8.0

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvDefaultFlatTableModel