Class BufferingLayoutController
java.lang.Object
org.jfree.report.flow.layoutprocessor.AbstractLayoutController
org.jfree.report.flow.layoutprocessor.BufferingLayoutController
- All Implemented Interfaces:
Cloneable
,LayoutController
Todo: Document me!
- Since:
- 05.03.2007
- Author:
- Thomas Morgner
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadvance
(ReportTarget target) Advances the processing position.clone()
Creates a copy of this layout controller.protected abstract LayoutController
void
initialize
(Object node, FlowController flowController, LayoutController parent) Initializes the layout controller.boolean
Checks, whether the layout controller would be advanceable.join
(FlowController flowController) Joins with a delegated process flow.protected LayoutController
Joins the layout controller with the parent.Methods inherited from class org.jfree.report.flow.layoutprocessor.AbstractLayoutController
createPrecomputeInstance, getFlowController, getNode, getParent, isInitialized
-
Constructor Details
-
BufferingLayoutController
protected BufferingLayoutController()
-
-
Method Details
-
advance
public LayoutController advance(ReportTarget target) throws DataSourceException, ReportDataFactoryException, ReportProcessingException Advances the processing position.- Parameters:
target
- the report target that receives generated events.- Returns:
- the new layout controller instance representing the new state.
- Throws:
DataSourceException
- if there was a problem reading data from the datasource.ReportProcessingException
- if there was a general problem during the report processing.ReportDataFactoryException
- if a query failed.
-
joinWithParent
protected LayoutController joinWithParent() throws ReportProcessingException, ReportDataFactoryException, DataSourceExceptionJoins the layout controller with the parent. This simply callsjoin(org.jfree.report.flow.FlowController)
on the parent. A join operation is necessary to propagate changes in the flow-controller to the parent for further processing.- Returns:
- the joined parent.
- Throws:
IllegalStateException
- if this layout controller has no parent.ReportProcessingException
ReportDataFactoryException
DataSourceException
-
initialize
public void initialize(Object node, FlowController flowController, LayoutController parent) throws DataSourceException, ReportDataFactoryException, ReportProcessingException Initializes the layout controller. This method is called exactly once. It is the creators responsibility to call this method. Calling initialize after the first advance must result in a IllegalStateException.- Specified by:
initialize
in interfaceLayoutController
- Overrides:
initialize
in classAbstractLayoutController
- Parameters:
node
- the currently processed object or layout node.flowController
- the current flow controller.parent
- the parent layout controller that was responsible for instantiating this controller.- Throws:
DataSourceException
- if there was a problem reading data from the datasource.ReportProcessingException
- if there was a general problem during the report processing.ReportDataFactoryException
- if a query failed.
-
getInitialDelegate
-
isAdvanceable
public boolean isAdvanceable()Description copied from interface:LayoutController
Checks, whether the layout controller would be advanceable. If this method returns true, it is generally safe to call the 'advance()' method.- Returns:
- true, if the layout controller is advanceable, false otherwise.
-
join
public LayoutController join(FlowController flowController) throws ReportProcessingException, DataSourceException Joins with a delegated process flow. This is generally called from a child flow and should *not* (I mean it!) be called from outside. If you do, you'll suffer.- Parameters:
flowController
- the flow controller of the parent.- Returns:
- the joined layout controller that incorperates all changes from the delegate.
- Throws:
ReportProcessingException
DataSourceException
-
clone
Description copied from interface:LayoutController
Creates a copy of this layout controller.- Specified by:
clone
in interfaceLayoutController
- Overrides:
clone
in classAbstractLayoutController
- Returns:
- a copy.
-