org.pentaho.reporting.engine.classic.core.states.datarow
Class ReportDataRow

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.states.datarow.ReportDataRow

public final class ReportDataRow
extends Object

Todo: Document Me

Author:
Thomas Morgner

Constructor Summary
ReportDataRow(TableModel reportData)
           
 
Method Summary
 ReportDataRow advance()
          Advances to the next row and attaches the given master row to the objects contained in that client data row.
static ReportDataRow createDataRow(DataFactory dataFactory, String query, int queryLimit, int queryTimeout, DataRow parameters)
           
 Object get(int col)
          Returns the value of the expression or column in the tablemodel using the given column number as index.
 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.
 int getCursor()
           
 TableModel getReportData()
           
 boolean isAdvanceable()
           
 boolean isReadable()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportDataRow

public ReportDataRow(TableModel reportData)
Method Detail

createDataRow

public static ReportDataRow createDataRow(DataFactory dataFactory,
                                          String query,
                                          int queryLimit,
                                          int queryTimeout,
                                          DataRow parameters)
                                   throws ReportDataFactoryException
Throws:
ReportDataFactoryException

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.

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.

getColumnCount

public int getColumnCount()
Returns the number of columns, expressions and functions and marked ReportProperties in the report.

Returns:
the item count.

advance

public ReportDataRow advance()
Advances to the next row and attaches the given master row to the objects contained in that client data row.

Returns:

isAdvanceable

public boolean isAdvanceable()

isReadable

public boolean isReadable()

getReportData

public TableModel getReportData()

getCursor

public int getCursor()