Interface LayoutController
- All Superinterfaces:
Cloneable
- All Known Implementing Classes:
AbstractLayoutController
,AutoTableItemLayoutController
,AutoTableLayoutController
,BufferingLayoutController
,ContentElementLayoutController
,ElementLayoutController
,ReportLayoutController
,SectionLayoutController
,StaticTextLayoutController
,SubReportLayoutController
The layout controller iterates over the report layout. It uses a flow
controller to query the data.
- Author:
- Thomas Morgner
-
Method Summary
Modifier and TypeMethodDescriptionadvance
(ReportTarget target) Advances the processing position.clone()
Creates a copy of this layout controller.Derives a copy of this controller that is suitable to perform a precomputation.getNode()
Retrieves the parent of this layout controller.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.
-
Method Details
-
getParent
LayoutController getParent()Retrieves the parent of this layout controller. This allows childs to query their context.- Returns:
- the layout controller's parent to
null
if there is no parent.
-
initialize
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.- 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.
-
advance
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.
-
isAdvanceable
boolean isAdvanceable()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
LayoutController join(FlowController flowController) throws DataSourceException, ReportDataFactoryException, ReportProcessingException 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:
DataSourceException
ReportDataFactoryException
ReportProcessingException
-
clone
Object clone()Creates a copy of this layout controller.- Returns:
- a copy.
-
createPrecomputeInstance
Derives a copy of this controller that is suitable to perform a precomputation. The returned layout controller must be independent from the it's anchestor controller.- Parameters:
fc
- a new flow controller for the precomputation.- Returns:
- a copy that is suitable for precomputation.
-
getFlowController
FlowController getFlowController() -
getNode
Object getNode()
-