org.jfree.report.flow

Interface FlowController

Known Implementing Classes:
DefaultFlowController

public interface FlowController

A flow-controller is an immutable object. Whenever an method, that may change the internal state of the controller, is invoked, a new instance of the controller is returned.
Author:
Thomas Morgner

Method Summary

FlowController
activateExpressions(ExpressionSlot[] expressions)
Activates expressions that compute running values.
FlowController
createPrecomputeInstance()
FlowController
deactivateExpressions()
ExpressionSlot[]
getActiveExpressions()
Returns the current expression slots of all currently active expressions.
String
getExportDescriptor()
GlobalMasterRow
getMasterRow()
PrecomputedValueRegistry
getPrecomputedValueRegistry()
ReportContext
getReportContext()
ReportJob
getReportJob()
boolean
isAdvanceRequested()
FlowController
performOperation(FlowControlOperation operation)
FlowController
performQuery(String query)
FlowController
performReturnFromQuery()
FlowController
performSubReportQuery(String query, ParameterMapping[] inputParameters, ParameterMapping[] outputParameters)

Method Details

activateExpressions

public FlowController activateExpressions(ExpressionSlot[] expressions)
            throws DataSourceException
Activates expressions that compute running values. This does not activate precomputed expressions.
Parameters:
expressions -
Returns:

createPrecomputeInstance

public FlowController createPrecomputeInstance()
            throws DataSourceException

deactivateExpressions

public FlowController deactivateExpressions()
            throws DataSourceException

getActiveExpressions

public ExpressionSlot[] getActiveExpressions()
            throws DataSourceException
Returns the current expression slots of all currently active expressions. (Maybe we should limit the access to the name and value of the expression instead?)
Returns:

getExportDescriptor

public String getExportDescriptor()

getMasterRow

public GlobalMasterRow getMasterRow()

getPrecomputedValueRegistry

public PrecomputedValueRegistry getPrecomputedValueRegistry()

getReportContext

public ReportContext getReportContext()

getReportJob

public ReportJob getReportJob()

isAdvanceRequested

public boolean isAdvanceRequested()

performOperation

public FlowController performOperation(FlowControlOperation operation)
            throws DataSourceException

performQuery

public FlowController performQuery(String query)
            throws ReportDataFactoryException,
                   DataSourceException

performReturnFromQuery

public FlowController performReturnFromQuery()
            throws DataSourceException

performSubReportQuery

public FlowController performSubReportQuery(String query,
                                            ParameterMapping[] inputParameters,
                                            ParameterMapping[] outputParameters)
            throws ReportDataFactoryException,
                   DataSourceException