org.pentaho.reporting.engine.classic.core.function
Interface ExpressionRuntime

All Known Implementing Classes:

GenericExpressionRuntime, InlineDataRowRuntime, LayoutExpressionRuntime, ParameterExpressionRuntime, WrapperExpressionRuntime

public interface ExpressionRuntime

The expression runtime encapsulates all properties of the current report processing run that might be needed to successfully evaluate an expression. The runtime grants access to the DataRow, the TableModel of the current report and the ProcessingContext.

Author:

Thomas Morgner

Method Summary

org.pentaho.reporting.libraries.base.config.Configuration	getConfiguration() Returns the report configuration that was used to initiate this processing run.
int	getCurrentGroup()
int	getCurrentRow() Returns the number of the row in the tablemodel that is currently being processed.
TableModel	getData() Grants access to the tablemodel was granted using report properties, now direct.
DataFactory	getDataFactory()
DataRow	getDataRow() Returns the current data-row.
DataSchema	getDataSchema()
String	getExportDescriptor() Returns the current export descriptor as returned by the OutputProcessorMetaData object.
int	getGroupStartRow(int groupIndex)
int	getGroupStartRow(String groupName)
ProcessingContext	getProcessingContext() Returns the current processing context.
ResourceBundleFactory	getResourceBundleFactory() Returns the resource-bundle factory of current processing context.

Method Detail

getDataRow

DataRow getDataRow()

Returns the current data-row. The datarow can be used to access the computed values of all expressions and functions and the current row in the tablemodel.

Returns:

the data-row.

getDataSchema

DataSchema getDataSchema()

getDataFactory

DataFactory getDataFactory()

getConfiguration

org.pentaho.reporting.libraries.base.config.Configuration getConfiguration()

Returns the report configuration that was used to initiate this processing run.

Returns:

the report configuration.

getResourceBundleFactory

ResourceBundleFactory getResourceBundleFactory()

Returns the resource-bundle factory of current processing context.

Returns:

the current resource-bundle factory.

getData

TableModel getData()

Grants access to the tablemodel was granted using report properties, now direct.

Returns:

the current tablemodel used in the report.

getCurrentRow

int getCurrentRow()

Returns the number of the row in the tablemodel that is currently being processed.

Returns:

the current row number.

getCurrentGroup

int getCurrentGroup()

getGroupStartRow

int getGroupStartRow(String groupName)

getGroupStartRow

int getGroupStartRow(int groupIndex)

getExportDescriptor

String getExportDescriptor()

Returns the current export descriptor as returned by the OutputProcessorMetaData object. The output descriptor is a simple string collections consisting of the following components: exportclass/type/subtype

For example, the PDF export would be: pageable/pdf and the StreamHTML export would return table/html/stream

Returns:

the export descriptor.

getProcessingContext

ProcessingContext getProcessingContext()

Returns the current processing context.

Returns:

the processing context.