org.jfree.report

Interface DataRow

public interface DataRow extends DataSet

This is the base interface for all data access collectors. A data-row adds a certain order to the elements in the dataset. It also allows statefull comparisions and data attributes using DataFlags.

The data-row is an internal concept of JFreeReport. The report engine will be responsible for creating and maintaining these implementations. Authors of functions and expressions usually dont have to care where a datarow comes from or at which particular instance they are looking right now.

Note: Do not attempt to cache the datarow outside the core engine. This can have funny sideeffects and might trigger the end of the world.

Author: Thomas Morgner

Method Summary
Object	get(int col) Returns the value of the expression or column in the tablemodel using the given column number as index.
Object	get(String col) Returns the value of the function, expression or column using its specific name.
int	getColumnCount() Returns the number of columns, expressions and functions and marked ReportProperties in the report.
String	getColumnName(int col) Returns the name of the column, expression or function.
DataFlags	getFlags(String col) Queries lowlevel meta-data for the current value of the specified column.
DataFlags	getFlags(int col) Queries lowlevel meta-data for the current value of the specified column.

Method Detail

get

public Object get(int col)

Returns the value of the expression or column in the tablemodel using the given column number as index. For functions and expressions, the getValue() method is called and for columns from the tablemodel the tablemodel method getValueAt(row, column) gets called.

Parameters: col the item index.

Returns: the value.

Throws: IllegalStateException if the datarow detected a deadlock. DataSourceException if an error occured.

get

public Object get(String col)

Returns the value of the function, expression or column using its specific name. The given name is translated into a valid column number and the the column is queried. For functions and expressions, the getValue() method is called and for columns from the tablemodel the tablemodel method getValueAt(row, column) gets called.

Parameters: col the item index.

Returns: the value.

Throws: IllegalStateException if the datarow detected a deadlock. DataSourceException if an error occured.

getColumnCount

public int getColumnCount()

Returns the number of columns, expressions and functions and marked ReportProperties in the report.

Returns: the item count.

Throws: DataSourceException if an error occured.

getColumnName

public String getColumnName(int col)

Returns the name of the column, expression or function. For columns from the tablemodel, the tablemodels getColumnName method is called. For functions, expressions and report properties the assigned name is returned.

Parameters: col the item index.

Returns: the name.

Throws: DataSourceException if an error occured.

getFlags

public DataFlags getFlags(String col)

Queries lowlevel meta-data for the current value of the specified column.

Parameters: col the colum for which to query the meta-data flags

Returns: the dataflag collection for the value in the named column

Throws: DataSourceException if an error occured.

getFlags

public DataFlags getFlags(int col)

Queries lowlevel meta-data for the current value of the specified column.

Parameters: col the colum for which to query the meta-data flags

Returns: the dataflag collection for the value in the specified column

Throws: DataSourceException if an error occured.