org.pentaho.reporting.engine.classic.core
Interface MetaTableModel

All Superinterfaces:

TableModel

All Known Implementing Classes:

CachableTableModel, IndexedMetaTableModel, IndexedMetaTableModel, IndexedTableModel, IndexedTableModel, LengthLimitingTableModel, OfflineTableModel, ScrollableResultSetTableModel

public interface MetaTableModel
extends TableModel

A extension of the classic table-model. If the tablemodel returned by the data-factory implements this interface, the report engine can make use of the extended meta-data provided for each column.

The meta-data given here is presentation level meta-data, so it describes how data from the data-set should be formatted or styled.

Author:

Thomas Morgner

Method Summary

DataAttributes	getCellDataAttributes(int row, int column) Returns the meta-attribute as Java-Object.
DataAttributes	getColumnAttributes(int column) Returns the column-level attributes for the given column.
DataAttributes	getTableAttributes() Returns table-wide attributes.
boolean	isCellDataAttributesSupported() Checks, whether cell-data attributes are supported by this tablemodel implementation.

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, getColumnClass, getColumnCount, getColumnName, getRowCount, getValueAt, isCellEditable, removeTableModelListener, setValueAt

Method Detail

getCellDataAttributes

DataAttributes getCellDataAttributes(int row,
                                     int column)

Returns the meta-attribute as Java-Object. The object type that is expected by the caller is defined in the TableMetaData property set. It is the responsibility of the implementor to map the native meta-data model into a model suitable for reporting.

Be aware that cell-level attributes do not make it into the designtime dataschema, as this dataschema only looks at the structural metadata available and does not contain any data references.

Parameters:

row - the row of the cell for which the meta-data is queried.

column - the index of the column for which the meta-data is queried.

Returns:

the meta-data object.

isCellDataAttributesSupported

boolean isCellDataAttributesSupported()

Checks, whether cell-data attributes are supported by this tablemodel implementation.

Returns:

true, if the model supports cell-level attributes, false otherwise.

getColumnAttributes

DataAttributes getColumnAttributes(int column)

Returns the column-level attributes for the given column.

Parameters:

column - the column.

Returns:

data-attributes, never null.

getTableAttributes

DataAttributes getTableAttributes()

Returns table-wide attributes. This usually contain hints about the data-source used to query the data as well as hints on the sort-order of the data.

Returns:

the table-attributes, never null.