IlvDefaultFlatListModel (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.chart.datax.flat.list.IlvAbstractFlatListModel
- - ilog.views.chart.datax.flat.list.IlvBasicFlatListModel
  - - ilog.views.chart.datax.flat.list.IlvDefaultFlatListModel

All Implemented Interfaces:

IlvFlatListModel, IlvDataConverter, IlvModelWithColumns, IlvObjectModelWithColumns, IlvBatchable, Cloneable

Direct Known Subclasses:

IlvBufferFlatListModel, IlvFlatTableToFlatListModel, IlvPropertyBasedFlatListModel
```
public class IlvDefaultFlatListModel
extends IlvBasicFlatListModel
implements Cloneable
```
This class is the default implementation of the IlvFlatListModel 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.list.IlvFlatListModel
  BEFORE_COLUMN_REMOVED_MASK, BEFORE_DATA_CHANGE_MASK, BEFORE_OBJECTS_REMOVED_MASK

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addObject(Object object)` Adds an object to the end of the model.
`void`	`addObject(Object object, Object[] data)` Adds an object to the end of the model.
`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`	`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.
`int`	`getIndexOf(Object object)` Returns the index of a model object in `getObjects()`.
`Object`	`getObjectAt(int index)` Returns the object at a given index in `getObjects()`.
`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.
`Object`	`getValueAt(Object object, int columnIndex)` Returns the value for the attribute number `columnIndex` in the given object.
`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.
`protected void`	`internalObjectsAdd(int index, Object object)` Adds an object to the list of objects internally stored in this model.
`protected void`	`internalObjectsRemove(int index)` Removes an object from the list of objects internally stored in this model.
`protected void`	`internalObjectsSet(int index, Object object)` Replaces an object in the list of objects internally stored in this model.
`protected boolean`	`isColumnComputed(int columnIndex)` Returns `true` if `setValueAt` and `setDoubleAt` on a given column have no effect.
`void`	`removeObject(Object object)` Removes an object from the model.
`void`	`removeObjects(Object[] objects, int firstIndex)` Removes some consecutive 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.list.IlvBasicFlatListModel
addColumn, addColumn, addColumn, disconnect, fireModelEvent, getColumn, getColumnCount, getColumns, insertColumn, insertColumn, insertColumn, removeColumn, setColumn, setColumnCount, setColumns

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
  - IlvDefaultFlatListModel
```
public IlvDefaultFlatListModel()
```
    Creates an empty model with no objects and zero columns.
  - IlvDefaultFlatListModel
```
public IlvDefaultFlatListModel(int numColumns)
```
    Creates an empty model with no objects and the given number of columns.
  - IlvDefaultFlatListModel
```
public IlvDefaultFlatListModel(IlvDataColumnInfo[] columns)
```
    Creates an empty model with no objects and the given columns.
  - IlvDefaultFlatListModel
```
public IlvDefaultFlatListModel(Collection objects,
                               IlvDataColumnInfo[] columns)
```
    Creates a model with the given objects and the given columns.
- Method Detail
  - getObjects
```
public List getObjects()
```
    Returns the objects in this model.
    
    Specified by:
    
    getObjects in interface IlvFlatListModel
    
    Returns:
    
    An unmodifiable list.
  - internalObjectsAdd
```
protected void internalObjectsAdd(int index,
                                  Object object)
```
    Adds an object to the list of objects internally stored in this model.
  - internalObjectsRemove
```
protected void internalObjectsRemove(int index)
```
    Removes an object from the list of objects internally stored in this model.
  - internalObjectsSet
```
protected void internalObjectsSet(int index,
                                  Object object)
```
    Replaces an object in the list of objects internally stored in this model.
  - 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
    
    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 IlvFlatListModel
    
    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.
  - isColumnComputed
```
protected boolean isColumnComputed(int columnIndex)
```
    Returns true if setValueAt and setDoubleAt on a given column have no effect.
    
    Overrides:
    
    isColumnComputed in class IlvBasicFlatListModel
  - 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 IlvFlatListModel
    
    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 IlvFlatListModel
    
    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 IlvFlatListModel
    
    Overrides:
    
    getSupportedEventsMask in class IlvBasicFlatListModel
    
    See Also:
    
    IlvFlatListModel.BEFORE_DATA_CHANGE_MASK, IlvFlatListModel.BEFORE_OBJECTS_REMOVED_MASK, IlvFlatListModel.BEFORE_COLUMN_REMOVED_MASK
  - getObjectAt
```
public Object getObjectAt(int index)
```
    Returns the object at a given index in getObjects().
    
    Throws:
    
    IllegalArgumentException - If the index is out of range.
  - getIndexOf
```
public int getIndexOf(Object object)
```
    Returns the index of a model object in getObjects().
    
    Throws:
    
    IllegalArgumentException - If the object is not contained in the model.
  - 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 end of the model.
  - addObject
```
public void addObject(Object object,
                      Object[] data)
```
    Adds an object to the end of the model.
    
    Parameters:
    
    data - The initial data of this object. It must be an array of getColumnCount() elements.
  - insertObject
```
public void insertObject(Object object,
                         int index)
```
    Adds an object to the model at a given index.
    
    Parameters:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    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.
  - removeObjects
```
public void removeObjects(Object[] objects,
                          int firstIndex)
```
    Removes some consecutive objects from the model.
    
    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.
  - createColumnStorage
```
protected ilog.views.chart.datax.flat.internal.storage.IlvColumnStorage createColumnStorage(IlvDataColumnInfo column)
```
    Creates the backing storage for a column value. This method can return null if the methods getValueAt and getDoubleAt do not need backing store.
  - 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 IlvBasicFlatListModel
  - clone
```
public Object clone()
```
    Returns a copy of this object.
    
    Overrides:
    
    clone in class IlvBasicFlatListModel

Class IlvDefaultFlatListModel

Field Summary

Fields inherited from interface ilog.views.chart.datax.flat.list.IlvFlatListModel

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

IlvDefaultFlatListModel

IlvDefaultFlatListModel

IlvDefaultFlatListModel

IlvDefaultFlatListModel

Method Detail

getObjects

internalObjectsAdd

internalObjectsRemove

internalObjectsSet

getValueAt

getDoubleAt

setValueAtInternal

setDoubleAtInternal

isColumnComputed

setValueAt

setDoubleAt

getSupportedEventsMask

getObjectAt

getIndexOf

setObjects

addObject

addObject

insertObject

insertObjects

insertObject

removeObject

removeObjects

clear

createColumnStorage

dispose

clone