org.jfree.report.flow
Interface FlowController

All 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.
 java.lang.String getExportDescriptor()
           
 GlobalMasterRow getMasterRow()
           
 PrecomputedValueRegistry getPrecomputedValueRegistry()
           
 ReportContext getReportContext()
           
 ReportJob getReportJob()
           
 boolean isAdvanceRequested()
           
 FlowController performOperation(FlowControlOperation operation)
           
 FlowController performQuery(java.lang.String query)
           
 FlowController performReturnFromQuery()
           
 FlowController performSubReportQuery(java.lang.String query, ParameterMapping[] inputParameters, ParameterMapping[] outputParameters)
           
 

Method Detail

performOperation

public FlowController performOperation(FlowControlOperation operation)
                                throws DataSourceException
Throws:
DataSourceException

getMasterRow

public GlobalMasterRow getMasterRow()

getReportContext

public ReportContext getReportContext()

getExportDescriptor

public java.lang.String getExportDescriptor()

isAdvanceRequested

public boolean isAdvanceRequested()

performQuery

public FlowController performQuery(java.lang.String query)
                            throws ReportDataFactoryException,
                                   DataSourceException
Throws:
ReportDataFactoryException
DataSourceException

performSubReportQuery

public FlowController performSubReportQuery(java.lang.String query,
                                            ParameterMapping[] inputParameters,
                                            ParameterMapping[] outputParameters)
                                     throws ReportDataFactoryException,
                                            DataSourceException
Throws:
ReportDataFactoryException
DataSourceException

activateExpressions

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

Parameters:
expressions -
Returns:
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:
Throws:
DataSourceException

deactivateExpressions

public FlowController deactivateExpressions()
                                     throws DataSourceException
Throws:
DataSourceException

getReportJob

public ReportJob getReportJob()

performReturnFromQuery

public FlowController performReturnFromQuery()
                                      throws DataSourceException
Throws:
DataSourceException

createPrecomputeInstance

public FlowController createPrecomputeInstance()
                                        throws DataSourceException
Throws:
DataSourceException

getPrecomputedValueRegistry

public PrecomputedValueRegistry getPrecomputedValueRegistry()