ilog.views.chart.datax.adapter

Class IlvDataSourceToFlatTableModel

java.lang.Object

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

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

ilog.views.chart.datax.adapter.IlvDataSourceToFlatTableModel

All Implemented Interfaces:

IlvFlatTableModel, IlvDataConverter, IlvModelWithColumns, IlvBatchable, Cloneable

public class IlvDataSourceToFlatTableModel
extends IlvBasicFlatTableModel

This class implements an IlvFlatTableModel, based on an IlvDataSource. The x and y values (and optionally the labels) of each data set become columns of this table. The number of rows is the maximum number of data points across all data sets in the data source.

Note: This model does not support adding and removing rows or columns.

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
IlvDataSourceToFlatTableModel(IlvDataSource dataSource) Creates a model backed by a given IlvDataSource.
IlvDataSourceToFlatTableModel(IlvDataSource dataSource, boolean includingLabels) Creates a model backed by a given IlvDataSource.

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.
double	getDoubleAt(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex, as a numeric value.
int	getRowCount() Returns the number of rows in the model.
int	getSupportedEventsMask() Returns a bit mask denoting the optional kind of events that is guaranteed to be sent by this model to the registered listeners.
IlvDataSource	getUnderlyingDataSource() Returns the underlying data source.
Object	getValueAt(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex.
void	insertColumn(int columnIndex, IlvDataColumnInfo column) This method throws an UnsupportedOperationException.
void	insertColumn(int columnIndex, IlvDataColumnInfo column, double[] data) This method throws an UnsupportedOperationException.
void	insertColumn(int columnIndex, IlvDataColumnInfo column, Object[] data) This method throws an UnsupportedOperationException.
protected boolean	isColumnComputed(int columnIndex) Returns true if setValueAtInternal and setDoubleAtInternal on a given column have no effect.
boolean	isIncludingLabels() Returns true if the labels are included as table columns.
void	removeColumn(int columnIndex) This method throws an UnsupportedOperationException.
void	setColumnCount(int columnCount) This method throws an UnsupportedOperationException.
void	setDoubleAt(double value, int rowIndex, int columnIndex) Sets the value in the cell at columnIndex and rowIndex to the given value.
protected boolean	setDoubleAtInternal(double value, int rowIndex, int columnIndex, boolean forReal) Does the equivalent of a setDoubleAt().
void	setValueAt(Object value, int rowIndex, int columnIndex) Sets the value in the cell at columnIndex and rowIndex to the given value.
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.IlvBasicFlatTableModel

addColumn, addColumn, addColumn, createColumnStorage, fireModelEvent, getColumn, getColumnCount, getColumns, setColumn, setColumns

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

IlvDataSourceToFlatTableModel

public IlvDataSourceToFlatTableModel(IlvDataSource dataSource)

Creates a model backed by a given IlvDataSource. It has columns containing the x and y values of each data set.

IlvDataSourceToFlatTableModel

public IlvDataSourceToFlatTableModel(IlvDataSource dataSource,
                                     boolean includingLabels)

Creates a model backed by a given IlvDataSource. It has columns containing the x and y values and, if includingLabels is true, for the labels of each data set.

Parameters:

includingLabels - whether to include columns for the labels

Since:

JViews 8.1

Method Detail

getRowCount

public int getRowCount()

Returns the number of rows in the model.

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

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Returns the value for the cell at columnIndex and rowIndex.

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.

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, telling whether the given value is different from the previous one.

Specified by:

setValueAtInternal in class IlvBasicFlatTableModel

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, telling whether the given value is different from the previous one.

Specified by:

setDoubleAtInternal in class IlvBasicFlatTableModel

isColumnComputed

protected boolean isColumnComputed(int columnIndex)

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

Overrides:

isColumnComputed in class IlvBasicFlatTableModel

setValueAt

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

Sets the value in the cell at columnIndex and rowIndex to the given value.

Specified by:

setValueAt in interface IlvFlatTableModel

Overrides:

setValueAt in class IlvBasicFlatTableModel

Parameters:

value - The new value.

rowIndex - The row containing the cell whose value is to be changed.

columnIndex - The column containing the cell whose value is to be changed.

setDoubleAt

public void setDoubleAt(double value,
                        int rowIndex,
                        int columnIndex)

Sets the value in the cell at columnIndex and rowIndex 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 IlvFlatTableModel

Overrides:

setDoubleAt in class IlvBasicFlatTableModel

Parameters:

value - The new value.

rowIndex - The row containing the cell whose value is to be changed.

columnIndex - The column containing the cell whose value is to be changed.

getSupportedEventsMask

public int getSupportedEventsMask()

Returns a bit mask denoting the optional kind of events that is guaranteed to be sent by this model to the registered listeners.

This implementation returns 0. It may need to be overridden in subclasses.

Specified by:

getSupportedEventsMask in interface IlvFlatTableModel

Overrides:

getSupportedEventsMask in class IlvBasicFlatTableModel

See Also:

IlvFlatTableModel.BEFORE_DATA_CHANGE_MASK, IlvFlatTableModel.BEFORE_ROWS_REMOVED_MASK, IlvFlatTableModel.BEFORE_COLUMN_REMOVED_MASK

setColumnCount

public void setColumnCount(int columnCount)

This method throws an UnsupportedOperationException.

Overrides:

setColumnCount in class IlvBasicFlatTableModel

Parameters:

columnCount - The new number of columns.

insertColumn

public void insertColumn(int columnIndex,
                         IlvDataColumnInfo column)

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

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)

This method throws an UnsupportedOperationException.

Overrides:

removeColumn in class IlvBasicFlatTableModel

Parameters:

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

getUnderlyingDataSource

public IlvDataSource getUnderlyingDataSource()

Returns the underlying data source.

Since:

JViews 8.1

isIncludingLabels

public boolean isIncludingLabels()

Returns true if the labels are included as table columns.

Since:

JViews 8.1

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 data source 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 IlvBasicFlatTableModel