ilog.views.chart.datax.adapter

Class IlvFlatSetToFlatTableModel

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.adapter.IlvFlatSetToFlatTableModel

All Implemented Interfaces:

IlvFlatTableModel, IlvDataConverter, IlvModelWithColumns, IlvBatchable, Cloneable

public class IlvFlatSetToFlatTableModel
extends IlvDefaultFlatTableModel

This class implements an IlvFlatTableModel, based on an IlvFlatSetModel.

The table columns are the attributes of the objects, plus a synthetic column called "object".

Note: This model supports adding and removing rows only if the underlying IlvFlatSetModel is an instance of IlvDefaultFlatSetModel. Adding rows furthermore requires the use of a constructor taking an IlvObjectFactory.

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
IlvFlatSetToFlatTableModel(IlvDefaultFlatSetModel model, IlvObjectFactory creator) Creates a model backed by a given IlvFlatSetModel, with the ability to add rows and with the same columns.
IlvFlatSetToFlatTableModel(IlvDefaultFlatSetModel model, IlvObjectFactory creator, IlvDataColumnInfo[] columns) Creates a model backed by a given ListModel, with the ability to add rows, and with the given columns.
IlvFlatSetToFlatTableModel(IlvDefaultFlatSetModel model, IlvObjectFactory creator, IlvDataColumnInfo[] columns, int eventsMaskHint) Creates a model backed by a given ListModel, with the ability to add rows, and with the given columns.
IlvFlatSetToFlatTableModel(IlvDefaultFlatSetModel model, IlvObjectFactory creator, int eventsMaskHint) Creates a model backed by a given IlvFlatSetModel, with the ability to add rows and with the same columns.
IlvFlatSetToFlatTableModel(IlvFlatSetModel model) Creates a model backed by a given IlvFlatSetModel, with the same columns.
IlvFlatSetToFlatTableModel(IlvFlatSetModel model, IlvDataColumnInfo[] columns) Creates a model backed by a given ListModel, with the given columns.
IlvFlatSetToFlatTableModel(IlvFlatSetModel model, IlvDataColumnInfo[] columns, int eventsMaskHint) Creates a model backed by a given ListModel, with the given columns.
IlvFlatSetToFlatTableModel(IlvFlatSetModel model, int eventsMaskHint) Creates a model backed by a given IlvFlatSetModel, with the same 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 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.
double	getDoubleAt(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex, as a numeric value.
int	getIndexOf(Object object) Returns the index of a model object in getUnderlyingModel().getObjects().
Object	getObjectAt(int index) Returns the object at a given index in getUnderlyingModel().getObjects().
int	getRowCount() Returns the number of rows in the model.
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.
IlvFlatSetModel	getUnderlyingModel() Returns the underlying model.
Object	getValueAt(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex.
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 have no effect on a given column.
void	removeColumn(int columnIndex) Removes a column from the model.
void	removeRows(int rowIndex, int count) Removes some rows 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.
protected boolean	setDoubleAtInternal(double value, int rowIndex, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
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, insertRow, removeRow

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

addColumn, addColumn, addColumn, fireModelEvent, getColumn, getColumnCount, getColumns, 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

IlvFlatSetToFlatTableModel

public IlvFlatSetToFlatTableModel(IlvFlatSetModel model)

Creates a model backed by a given IlvFlatSetModel, with the same columns.

Note: No rows can be added when this constructor is used.

Parameters:

model - The underlying model.

IlvFlatSetToFlatTableModel

public IlvFlatSetToFlatTableModel(IlvFlatSetModel model,
                                  int eventsMaskHint)

Creates a model backed by a given IlvFlatSetModel, with the same columns.

Note: No rows can be added when this constructor is used.

Parameters:

model - The underlying model.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

IlvFlatSetToFlatTableModel

public IlvFlatSetToFlatTableModel(IlvDefaultFlatSetModel model,
                                  IlvObjectFactory creator)

Creates a model backed by a given IlvFlatSetModel, with the ability to add rows and with the same columns.

Parameters:

model - The underlying model.

creator - Factory for new objects in the model.

IlvFlatSetToFlatTableModel

public IlvFlatSetToFlatTableModel(IlvDefaultFlatSetModel model,
                                  IlvObjectFactory creator,
                                  int eventsMaskHint)

Creates a model backed by a given IlvFlatSetModel, with the ability to add rows and with the same columns.

Parameters:

model - The underlying model.

creator - Factory for new objects in the model.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

IlvFlatSetToFlatTableModel

public IlvFlatSetToFlatTableModel(IlvFlatSetModel model,
                                  IlvDataColumnInfo[] columns)

Creates a model backed by a given ListModel, with the given columns.

Note: No rows can be added when this constructor is used.

Parameters:

model - The underlying model.

columns - The initial list of columns of this model.

IlvFlatSetToFlatTableModel

public IlvFlatSetToFlatTableModel(IlvFlatSetModel model,
                                  IlvDataColumnInfo[] columns,
                                  int eventsMaskHint)

Creates a model backed by a given ListModel, with the given columns.

Note: No rows can be added when this constructor is used.

Parameters:

model - The underlying model.

columns - The initial list of columns of this model.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

IlvFlatSetToFlatTableModel

public IlvFlatSetToFlatTableModel(IlvDefaultFlatSetModel model,
                                  IlvObjectFactory creator,
                                  IlvDataColumnInfo[] columns)

Creates a model backed by a given ListModel, with the ability to add rows, and with the given columns.

Parameters:

model - The underlying model.

creator - Factory for new objects in the model.

columns - The initial list of columns of this model.

IlvFlatSetToFlatTableModel

public IlvFlatSetToFlatTableModel(IlvDefaultFlatSetModel model,
                                  IlvObjectFactory creator,
                                  IlvDataColumnInfo[] columns,
                                  int eventsMaskHint)

Creates a model backed by a given ListModel, with the ability to add rows, and with the given columns.

Parameters:

model - The underlying model.

creator - Factory for new objects in the model.

columns - The initial list of columns of this model.

eventsMaskHint - Desired events mask. This is just a hint; there is no guarantee that the event types designated by the mask are supported by this model.

Since:

JViews 8.0

Method Detail

getRowCount

public int getRowCount()

Returns the number of rows in the model.

Valid row indices range from 0 to getRowCount()-1 (inclusive).

Specified by:

getRowCount in interface IlvFlatTableModel

Overrides:

getRowCount in class IlvDefaultFlatTableModel

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Returns the value for the cell at columnIndex and rowIndex.

Specified by:

getValueAt in interface IlvFlatTableModel

Overrides:

getValueAt in class IlvDefaultFlatTableModel

getDoubleAt

public double getDoubleAt(int rowIndex,
                          int columnIndex)

Returns the value for the cell at columnIndex and rowIndex, as a numeric value.

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 IlvFlatTableModel

Overrides:

getDoubleAt in class IlvDefaultFlatTableModel

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, indicating 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, indicating 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 have no effect on a given column.

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 a mask that corresponds to the one of the underlying model, intersected with the eventsMaskHint constructor argument. It ought 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.

createColumnStorage

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

Description copied from class: IlvBasicFlatTableModel

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

Overrides:

createColumnStorage in class IlvBasicFlatTableModel

setColumnCount

public void setColumnCount(int columnCount)

Description copied from class: IlvBasicFlatTableModel

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)

Description copied from class: IlvBasicFlatTableModel

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)

Description copied from class: IlvBasicFlatTableModel

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)

Description copied from class: IlvBasicFlatTableModel

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)

Description copied from class: IlvBasicFlatTableModel

Removes a column from the model.

Overrides:

removeColumn in class IlvBasicFlatTableModel

Parameters:

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

setColumns

public void setColumns(List<IlvDataColumnInfo> columns)

Description copied from class: IlvBasicFlatTableModel

Sets the list of columns.

Overrides:

setColumns in class IlvBasicFlatTableModel

Parameters:

columns - A list of IlvDataColumnInfo.

setColumn

public void setColumn(int i,
                      IlvDataColumnInfo column)

Description copied from class: IlvBasicFlatTableModel

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

Overrides:

setColumn in class IlvBasicFlatTableModel

column - An IlvDataColumnInfo.

getUnderlyingModel

public IlvFlatSetModel getUnderlyingModel()

Returns the underlying model.

Returns:

The IlvFlatSetModel passed to the constructor.

getObjectAt

public Object getObjectAt(int index)

Returns the object at a given index in getUnderlyingModel().getObjects().

Throws:

IllegalArgumentException - If the index is out of range.

getIndexOf

public int getIndexOf(Object object)

Returns the index of a model object in getUnderlyingModel().getObjects().

Throws:

IllegalArgumentException - If the object is not contained in the model.

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, 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