org.pentaho.reporting.engine.classic.core
Class ReportEnvironmentDataRow

java.lang.Object
  org.pentaho.reporting.engine.classic.core.ReportEnvironmentDataRow

All Implemented Interfaces:

DataRow

public class ReportEnvironmentDataRow
extends Object
implements DataRow

Todo: Document me!

Date: 11.11.2009 Time: 15:11:56

Author:

Thomas Morgner.

Constructor Summary

ReportEnvironmentDataRow(ReportEnvironment environment)

Method Summary

static org.pentaho.reporting.libraries.base.util.LinkedMap	createEnvironmentMapping() Creates a ordered map that contains the environment names as keys and the data-row column names as values.
Object	get(String col) Returns the value of the function, expression or column using its specific name.
String[]	getColumnNames() Returns the known column names, this data-row understands.
ReportEnvironment	getEnvironment()
boolean	isArray(String columnName)
boolean	isChanged(String name) Checks whether the value contained in the column has changed since the last advance-operation.
boolean	isRolesArray(String columnName) Deprecated. use "isArray" instead.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReportEnvironmentDataRow

public ReportEnvironmentDataRow(ReportEnvironment environment)

Method Detail

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.

Specified by:

get in interface DataRow

Parameters:

col - the item index.

Returns:

the value.

getColumnNames

public String[] getColumnNames()

Returns the known column names, this data-row understands. The column names may change over time but do not change while a event is processed by a function. The array returned is a copy of the internal data-storage and can be safely modified.

Specified by:

getColumnNames in interface DataRow

Returns:

the column names as array.

isChanged

public boolean isChanged(String name)

Checks whether the value contained in the column has changed since the last advance-operation.

Specified by:

isChanged in interface DataRow

Parameters:

name - the name of the column.

Returns:

true, if the value has changed, false otherwise.

isArray

public boolean isArray(String columnName)

isRolesArray

public boolean isRolesArray(String columnName)

Deprecated. use "isArray" instead.

Parameters:

columnName -

Returns:

createEnvironmentMapping

public static org.pentaho.reporting.libraries.base.util.LinkedMap createEnvironmentMapping()

Creates a ordered map that contains the environment names as keys and the data-row column names as values.

Returns:

the mapping from environment names to data-row column names.

getEnvironment

public ReportEnvironment getEnvironment()

toString

public String toString()

Overrides:

toString in class Object