ilog.views.chart.datax.flat.set

Class IlvDefaultFlatSetModel

java.lang.Object

ilog.views.chart.datax.flat.set.IlvAbstractFlatSetModel

ilog.views.chart.datax.flat.set.IlvBasicFlatSetModel

ilog.views.chart.datax.flat.set.IlvDefaultFlatSetModel

All Implemented Interfaces:

IlvFlatSetModel, IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvBatchable, Cloneable

Direct Known Subclasses:

IlvBufferFlatSetModel, IlvPropertyBasedFlatSetModel

public class IlvDefaultFlatSetModel
extends IlvBasicFlatSetModel
implements Cloneable

This class is the default implementation of the IlvFlatSetModel interface.

It stores the objects, the data values and the column info objects locally in this instance.

Since:

JViews 7.5

Field Summary

Fields inherited from interface ilog.views.chart.datax.flat.set.IlvFlatSetModel

BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK

Constructor Summary

Constructors

Constructor and Description
IlvDefaultFlatSetModel() Creates an empty model with no objects and zero columns.
IlvDefaultFlatSetModel(Collection objects, IlvDataColumnInfo[] columns) Creates a model with the given objects and the given columns.
IlvDefaultFlatSetModel(IlvDataColumnInfo[] columns) Creates an empty model with no objects and the given columns.
IlvDefaultFlatSetModel(int numColumns) Creates an empty model with no objects and the given number of columns.

Method Summary

Modifier and Type	Method and Description
void	addObject(Object object) Adds an object to the model.
void	addObject(Object object, Object[] data) Adds an object to the model.
void	addObjects(Object[] objects) Adds some objects to the model.
void	clear() Removes all objects from the model.
Object	clone() Returns a copy of this object.
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.
Collection	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.
Object	getValueAt(Object object, int columnIndex) Returns the value for the attribute number columnIndex in the given object.
void	removeObject(Object object) Removes an object from the model.
void	removeObjects(Object[] objects) Removes some objects from the model.
void	setDoubleAt(double value, Object object, int columnIndex) Sets the value for the attribute number columnIndex in the given object to the given value.
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.
void	setValueAt(Object value, Object object, int columnIndex) Sets the value for the attribute number columnIndex in the given object to the given value.
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.set.IlvBasicFlatSetModel

addColumn, addColumn, addColumn, disconnect, fireModelEvent, getColumn, getColumnCount, getColumns, insertColumn, insertColumn, insertColumn, removeColumn, setColumn, setColumnCount, setColumns

Methods inherited from class ilog.views.chart.datax.flat.set.IlvAbstractFlatSetModel

addFlatSetModelListener, convertToDouble, endBatch, removeFlatSetModelListener, startBatch

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvDefaultFlatSetModel

public IlvDefaultFlatSetModel()

Creates an empty model with no objects and zero columns.

IlvDefaultFlatSetModel

public IlvDefaultFlatSetModel(int numColumns)

Creates an empty model with no objects and the given number of columns.

IlvDefaultFlatSetModel

public IlvDefaultFlatSetModel(IlvDataColumnInfo[] columns)

Creates an empty model with no objects and the given columns.

IlvDefaultFlatSetModel

public IlvDefaultFlatSetModel(Collection objects,
                              IlvDataColumnInfo[] columns)

Creates a model with the given objects and the given columns.

Method Detail

getObjects

public Collection getObjects()

Returns the objects in this model.

Specified by:

getObjects in interface IlvFlatSetModel

Returns:

An unmodifiable collection.

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 IlvFlatSetModel

Specified by:

getValueAt in interface IlvObjectModelWithColumns

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.

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 IlvFlatSetModel

Specified by:

getDoubleAt in interface IlvObjectModelWithColumns

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.

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.

setValueAt

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

Sets the value for the attribute number columnIndex in the given object to the given value.

Specified by:

setValueAt in interface IlvFlatSetModel

Specified by:

setValueAt in interface IlvObjectModelWithColumns

Parameters:

value - The new value.

object - The object (row) in which the value is to be changed.

columnIndex - The column denoting the attribute whose value is to be changed.

setDoubleAt

public void setDoubleAt(double value,
                        Object object,
                        int columnIndex)

Sets the value for the attribute number columnIndex in the given object 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 IlvFlatSetModel

Specified by:

setDoubleAt in interface IlvObjectModelWithColumns

Parameters:

value - The new value.

object - The object (row) in which the value is to be changed.

columnIndex - The column denoting the attribute 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_OBJECTS_REMOVED_MASK | BEFORE_COLUMN_REMOVED_MASK. It may need to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvFlatSetModel

Overrides:

getSupportedEventsMask in class IlvBasicFlatSetModel

See Also:

IlvFlatSetModel.BEFORE_DATA_CHANGE_MASK, IlvFlatSetModel.BEFORE_OBJECTS_REMOVED_MASK, IlvFlatSetModel.BEFORE_COLUMN_REMOVED_MASK

setObjects

public void setObjects(Collection objects)

Replaces the set of objects in the model.

addObject

public void addObject(Object object)

Adds an object to the model.

addObjects

public void addObjects(Object[] objects)

Adds some objects to the model.

addObject

public void addObject(Object object,
                      Object[] data)

Adds an object to the model.

Parameters:

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

removeObject

public void removeObject(Object object)

Removes an object from the model.

removeObjects

public void removeObjects(Object[] objects)

Removes some objects from the model.

clear

public void clear()

Removes all objects from 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 IlvBasicFlatSetModel

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class IlvBasicFlatSetModel