ilog.views.chart.datax.adapter

Class IlvFlatTableToFlatListModel

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

All Implemented Interfaces:

IlvFlatListModel, IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvBatchable, Cloneable

public class IlvFlatTableToFlatListModel
extends IlvDefaultFlatListModel

This class implements an IlvFlatListModel, based on an IlvFlatTableModel. Every row in the IlvFlatTableModel becomes an element in the IlvFlatListModel.

Note: This model supports adding and removing objects 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.list.IlvFlatListModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvFlatTableToFlatListModel(IlvFlatTableModel model) Creates a model backed by a given IlvFlatTableModel, with the same columns.
IlvFlatTableToFlatListModel(IlvFlatTableModel model, IlvDataColumnInfo[] columns) Creates a model backed by a given IlvFlatTableModel, with the given columns.
IlvFlatTableToFlatListModel(IlvFlatTableModel model, IlvDataColumnInfo[] columns, int eventsMaskHint) Creates a model backed by a given IlvFlatTableModel, with the given columns.
IlvFlatTableToFlatListModel(IlvFlatTableModel model, int eventsMaskHint) Creates a model backed by a given IlvFlatTableModel, with the same columns.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all the objects from 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 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.
List	getObjects() Returns the objects in this 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.
IlvFlatTableModel	getUnderlyingModel() Returns the underlying model.
Object	getValueAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
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	insertObject(Object object, int index) Adds an object to the model at a given index.
void	insertObject(Object object, Object[] data, int index) Adds an object to the model at a given index.
void	insertObjects(Object[] objects, int index) Adds some objects to the model at a given index.
void	removeColumn(int columnIndex) Removes a column from the model.
void	removeObject(Object object) Removes an object from the model.
void	removeObjects(Object[] objects, int firstIndex) Removes some consecutive objects 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, Object object, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
void	setObjects(Collection objects) Replaces the set of objects in the model.
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, getIndexOf, getObjectAt, internalObjectsAdd, internalObjectsRemove, internalObjectsSet, isColumnComputed, setDoubleAt, setValueAt

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

addColumn, addColumn, addColumn, fireModelEvent, getColumn, getColumnCount, getColumns

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

IlvFlatTableToFlatListModel

public IlvFlatTableToFlatListModel(IlvFlatTableModel model)

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

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

Parameters:

model - The underlying model.

IlvFlatTableToFlatListModel

public IlvFlatTableToFlatListModel(IlvFlatTableModel model,
                                   int eventsMaskHint)

Creates a model backed by a given IlvFlatTableModel, 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

IlvFlatTableToFlatListModel

public IlvFlatTableToFlatListModel(IlvFlatTableModel model,
                                   IlvDataColumnInfo[] columns)

Creates a model backed by a given IlvFlatTableModel, 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.

IlvFlatTableToFlatListModel

public IlvFlatTableToFlatListModel(IlvFlatTableModel model,
                                   IlvDataColumnInfo[] columns,
                                   int eventsMaskHint)

Creates a model backed by a given IlvFlatTableModel, 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

Method Detail

getObjects

public List getObjects()

Returns the objects in this model.

Specified by:

getObjects in interface IlvFlatListModel

Overrides:

getObjects in class IlvDefaultFlatListModel

Returns:

An unmodifiable list.

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.

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

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.

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, intersected with the eventsMaskHint constructor argument. 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

setObjects

public void setObjects(Collection objects)

Replaces the set of objects in the model. This method throws an UnsupportedOperationException.

Overrides:

setObjects in class IlvDefaultFlatListModel

insertObject

public void insertObject(Object object,
                         int index)

Adds an object to the model at a given index.

Overrides:

insertObject in class IlvDefaultFlatListModel

index - The object desired index. It must be >= 0 and <= getObjects().size().

insertObjects

public void insertObjects(Object[] objects,
                          int index)

Adds some objects to the model at a given index.

Overrides:

insertObjects in class IlvDefaultFlatListModel

index - The first index of the new object. It must be >= 0 and <= getObjects().size().

insertObject

public void insertObject(Object object,
                         Object[] data,
                         int index)

Adds an object to the model at a given index.

Overrides:

insertObject in class IlvDefaultFlatListModel

data - The initial data of this object. It must be an array of getColumnCount() elements.

index - The index of the new object. It must be >= 0 and <= getObjects().size().

removeObject

public void removeObject(Object object)

Removes an object from the model.

Overrides:

removeObject in class IlvDefaultFlatListModel

removeObjects

public void removeObjects(Object[] objects,
                          int firstIndex)

Removes some consecutive objects from the model.

Overrides:

removeObjects in class IlvDefaultFlatListModel

Parameters:

objects - The objects that were at indices firstIndex, ..., firstIndex+objects.length-1 of getObjects().iterator().

clear

public void clear()

Removes all the objects from the model.

Overrides:

clear in class IlvDefaultFlatListModel

createColumnStorage

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

Description copied from class: IlvDefaultFlatListModel

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

setColumnCount

public void setColumnCount(int columnCount)

Description copied from class: IlvBasicFlatListModel

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 IlvBasicFlatListModel

Parameters:

columnCount - The new number of columns.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column)

Description copied from class: IlvBasicFlatListModel

Adds a column to the model at a given index.

Overrides:

insertColumn in class IlvBasicFlatListModel

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: IlvBasicFlatListModel

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

Overrides:

insertColumn in class IlvBasicFlatListModel

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 getObjects().size() elements. Not used if the column is a computed column.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column,
                         double[] data)

Description copied from class: IlvBasicFlatListModel

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

Overrides:

insertColumn in class IlvBasicFlatListModel

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 getObjects().size() elements. Not used if the column is a computed column.

removeColumn

public void removeColumn(int columnIndex)

Description copied from class: IlvBasicFlatListModel

Removes a column from the model.

Overrides:

removeColumn in class IlvBasicFlatListModel

Parameters:

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

setColumns

public void setColumns(List<IlvDataColumnInfo> columns)

Description copied from class: IlvBasicFlatListModel

Sets the list of columns.

Overrides:

setColumns in class IlvBasicFlatListModel

Parameters:

columns - A list of IlvDataColumnInfo.

setColumn

public void setColumn(int i,
                      IlvDataColumnInfo column)

Description copied from class: IlvBasicFlatListModel

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

Overrides:

setColumn in class IlvBasicFlatListModel

column - An IlvDataColumnInfo.

getUnderlyingModel

public IlvFlatTableModel getUnderlyingModel()

Returns the underlying model.

Returns:

The IlvFlatTableModel passed to the constructor.

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 model, 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. Note that the model objects created by this model will be cloned. Therefore, the cloned model will contain equivalent objects, but the same objects, as this model.

Overrides:

clone in class IlvDefaultFlatListModel