ilog.views.chart.datax.flat.table

Interface IlvFlatTableModel

All Superinterfaces:

IlvBatchable, IlvModelWithColumns

All Known Implementing Classes:

IlvAbstractFlatTableModel, IlvBasicFlatTableModel, IlvBufferFlatTableModel, IlvDataSourceToFlatTableModel, IlvDefaultFlatTableModel, IlvFilterFlatTableModel, IlvFlatListToFlatTableModel, IlvFlatSetToFlatTableModel, IlvListToFlatTableModel, IlvTableToFlatTableModel, IlvTreeListToFlatTableModel, IlvTreeToFlatTableModel

public interface IlvFlatTableModel
extends IlvModelWithColumns, IlvBatchable

This interface represents data that can be viewed through a structured chart.

The data has the form of a table. Each row represents a record or real-world object, and each column represents an attribute of this record or object.

The columns have some metainformation, like the column number, name, value type, and so on.

In implementations of this model that are only connected to the JViews Chart component, you can implement the setValueAt and setDoubleAt methods as empty: these methods are not invoked by the JViews Charts view.

Since:

JViews 7.5

See Also:

IlvDataColumnInfo, IlvAbstractFlatTableModel, IlvDefaultFlatTableModel, FlatTableModelEvent, FlatTableModelListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	BEFORE_COLUMN_REMOVED_MASK When returned by getSupportedEventsMask(), this bit mask denotes that a FlatTableModelEvent.Type.BEFORE_COLUMN_REMOVED event is guaranteed to be fired before every FlatTableModelEvent.Type.COLUMN_REMOVED event.
static int	BEFORE_DATA_CHANGE_MASK When returned by getSupportedEventsMask(), this bit mask denotes that a FlatTableModelEvent.Type.BEFORE_DATA_CHANGE event is guaranteed to be fired before every FlatTableModelEvent.Type.DATA_CHANGED event.
static int	BEFORE_ROWS_REMOVED_MASK When returned by getSupportedEventsMask(), this bit mask denotes that a FlatTableModelEvent.Type.BEFORE_ROWS_REMOVED event is guaranteed to be fired before every FlatTableModelEvent.Type.ROWS_REMOVED event.

Method Summary

Modifier and Type	Method and Description
void	addFlatTableModelListener(FlatTableModelListener listener) Adds a listener.
void	endBatch() Terminates a group of modifications.
IlvDataColumnInfo	getColumn(int columnIndex) Returns metainformation about a column.
int	getColumnCount() Returns the number of columns in the model.
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 kinds of events that are guaranteed to be sent by this model to the registered listeners.
Object	getValueAt(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex.
void	removeFlatTableModelListener(FlatTableModelListener listener) Removes a listener.
void	setDoubleAt(double value, int rowIndex, int columnIndex) Sets the value in the cell at columnIndex and rowIndex to the given value.
void	setValueAt(Object value, int rowIndex, int columnIndex) Sets the value in the cell at columnIndex and rowIndex to the given value.
void	startBatch() Starts a group of modifications.

Field Detail

BEFORE_DATA_CHANGE_MASK

static final int BEFORE_DATA_CHANGE_MASK

When returned by getSupportedEventsMask(), this bit mask denotes that a FlatTableModelEvent.Type.BEFORE_DATA_CHANGE event is guaranteed to be fired before every FlatTableModelEvent.Type.DATA_CHANGED event.

See Also:

getSupportedEventsMask(), Constant Field Values

BEFORE_ROWS_REMOVED_MASK

static final int BEFORE_ROWS_REMOVED_MASK

When returned by getSupportedEventsMask(), this bit mask denotes that a FlatTableModelEvent.Type.BEFORE_ROWS_REMOVED event is guaranteed to be fired before every FlatTableModelEvent.Type.ROWS_REMOVED event.

See Also:

getSupportedEventsMask(), Constant Field Values

BEFORE_COLUMN_REMOVED_MASK

static final int BEFORE_COLUMN_REMOVED_MASK

When returned by getSupportedEventsMask(), this bit mask denotes that a FlatTableModelEvent.Type.BEFORE_COLUMN_REMOVED event is guaranteed to be fired before every FlatTableModelEvent.Type.COLUMN_REMOVED event.

See Also:

getSupportedEventsMask(), Constant Field Values

Method Detail

getRowCount

int getRowCount()

Returns the number of rows in the model.

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

getColumnCount

int getColumnCount()

Returns the number of columns in the model.

Valid column indices range from 0 to getColumnCount()-1 (inclusive).

Specified by:

getColumnCount in interface IlvModelWithColumns

getValueAt

Object getValueAt(int rowIndex,
                  int columnIndex)

Returns the value for the cell at columnIndex and rowIndex.

setValueAt

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

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

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.

getDoubleAt

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.

setDoubleAt

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.

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.

getColumn

IlvDataColumnInfo getColumn(int columnIndex)

Returns metainformation about a column.

Specified by:

getColumn in interface IlvModelWithColumns

Parameters:

columnIndex - The column.

startBatch

void startBatch()

Starts a group of modifications.

Specified by:

startBatch in interface IlvBatchable

endBatch

void endBatch()

Terminates a group of modifications.

Specified by:

endBatch in interface IlvBatchable

addFlatTableModelListener

void addFlatTableModelListener(FlatTableModelListener listener)

Adds a listener. It will be notified each time a change in the data or in the column metainformation occurs.

removeFlatTableModelListener

void removeFlatTableModelListener(FlatTableModelListener listener)

Removes a listener. Unregisters the given listener from the notification list.

getSupportedEventsMask

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.

It is always safe to implement this method by returning 0.

If a given model does not support the events that you need, you can wrap the model in an IlvBufferFlatTableModel: the wrapped model will support all events.

See Also:

BEFORE_DATA_CHANGE_MASK, BEFORE_ROWS_REMOVED_MASK, BEFORE_COLUMN_REMOVED_MASK