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

All Known Implementing Classes:

DefaultProcessingContext

public interface ProcessingContext

The processing context hold information about the progress of the report processing and contains global properties used during the report processing.

Author:

Thomas Morgner

Method Summary

int	getCompatibilityLevel()
org.pentaho.reporting.libraries.base.config.Configuration	getConfiguration() Returns the initial master-report's configuration.
org.pentaho.reporting.libraries.resourceloader.ResourceKey	getContentBase() Returns the content base of the initial master-report.
org.pentaho.reporting.libraries.docbundle.DocumentMetaData	getDocumentMetaData() Returns the outermost master-report's document meta-data.
ReportEnvironment	getEnvironment()
String	getExportDescriptor() Returns the export descriptor from the output-target.
org.pentaho.reporting.libraries.formula.FormulaContext	getFormulaContext() Returns the formula context of this report process.
LayoutSupport	getLayoutSupport() Deprecated. the layouter works differently now. The layout-support returned here is a dummy implementation and does no longer reflect the real layout computations.
OutputProcessorMetaData	getOutputProcessorMetaData()
int	getProcessingLevel() The processing-level is used for dependency tracking.
int	getProgressLevel() Returns the current progress level.
int	getProgressLevelCount() Returns the total number of different activities the report will process.
ResourceBundleFactory	getResourceBundleFactory() The resource-bundle factory encapsulates all locale specific resources and provides a system-independent way to create Resource-Bundles.
org.pentaho.reporting.libraries.resourceloader.ResourceManager	getResourceManager() Returns the initial master-report's resource manager.
boolean	isPrepareRun() Returns true, if the current processing run is a prepare-run.

Method Detail

getProgressLevel

int getProgressLevel()

Returns the current progress level. The number itself has no meaning and is only used to measure the progress of the report processing.

Returns:

the progress level.

getProgressLevelCount

int getProgressLevelCount()

Returns the total number of different activities the report will process.

Returns:

the number of different progress levels.

getProcessingLevel

int getProcessingLevel()

The processing-level is used for dependency tracking. A function that precomputes values should use this level value to determine its current activity.

Returns:

the processing level.

See Also:

Expression.getDependencyLevel()

getFormulaContext

org.pentaho.reporting.libraries.formula.FormulaContext getFormulaContext()

Returns the formula context of this report process. The formula context is required to evaluate inline expression with LibFormula.

Returns:

the current formula context.

isPrepareRun

boolean isPrepareRun()

Returns true, if the current processing run is a prepare-run. A prepare run does not generate content, but will be needed to compute the layout. This flag can be used to possibly optimize the content computation. If in doubt on how to interpret the flag, then please ignore this flag. The process may be slightly slower, but at least it will work all the time.

Returns:

true, if this is a prepare-run, false if this is a content processing run.

getExportDescriptor

String getExportDescriptor()

Returns the export descriptor from the output-target.

Returns:

the export descriptor string.

See Also:

OutputProcessorMetaData.getExportDescriptor()

getOutputProcessorMetaData

OutputProcessorMetaData getOutputProcessorMetaData()

getLayoutSupport

LayoutSupport getLayoutSupport()

Deprecated. the layouter works differently now. The layout-support returned here is a dummy implementation and does no longer reflect the real layout computations.

Returns the layout support. The layout support allows functions to do basic layouting.

Returns:

the layout support.

getResourceBundleFactory

ResourceBundleFactory getResourceBundleFactory()

The resource-bundle factory encapsulates all locale specific resources and provides a system-independent way to create Resource-Bundles. This returns the initial master-report's resource-bundle factory.

Returns:

the report's resource-bundle factory.

getContentBase

org.pentaho.reporting.libraries.resourceloader.ResourceKey getContentBase()

Returns the content base of the initial master-report. The content-base resource-key can be used to resolve relative paths.

Returns:

the initial content base or null, if there is no content-base.

getResourceManager

org.pentaho.reporting.libraries.resourceloader.ResourceManager getResourceManager()

Returns the initial master-report's resource manager. The resource manager can be used to load external resources in a system-independent way.

Returns:

the master-report's resourcemanager.

getConfiguration

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

Returns the initial master-report's configuration. The initial configuration is used for all subreports.

Returns:

the global report configuration.

getDocumentMetaData

org.pentaho.reporting.libraries.docbundle.DocumentMetaData getDocumentMetaData()

Returns the outermost master-report's document meta-data.

Returns:

the document meta-data.

getEnvironment

ReportEnvironment getEnvironment()

getCompatibilityLevel

int getCompatibilityLevel()