AbstractReportGenerator (Smooks 2.0.0-RC4 API)

java.lang.Object
- org.smooks.engine.delivery.event.BasicExecutionEventListener
- - org.smooks.engine.report.AbstractReportGenerator

All Implemented Interfaces:

ExecutionEventListener, DOMFilterLifecycle, FilterLifecycle

Direct Known Subclasses:

FlatReportGenerator, HtmlReportGenerator
```
public abstract class AbstractReportGenerator
extends BasicExecutionEventListener
implements FilterLifecycle, DOMFilterLifecycle
```
Abstract execution report generator.

Author:

tom.fennelly@gmail.com

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class AbstractReportGenerator.ReportNode

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractReportGenerator(ReportConfiguration reportConfiguration, ApplicationContext applicationContext)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract void`	`applyTemplate(Report report)`
`Writer`	`getOutputWriter()`
`ReportConfiguration`	`getReportConfiguration()`
`protected boolean`	`ignoreEvent(ExecutionEvent event)`
`void`	`onAssemblyStarted(ExecutionContext executionContext)`
`void`	`onEvent(ExecutionEvent executionEvent)`	Process the `ExecutionEvent`.
`void`	`onPostFilter(ExecutionContext executionContext)`
`void`	`onPreFilter(ExecutionContext executionContext)`
`void`	`onProcessingStarted(ExecutionContext executionContext)`
`void`	`onSerializationStarted(ExecutionContext executionContext)`
`protected void`	`processFinishEvent(ExecutionContext executionContext)`

Methods inherited from class org.smooks.engine.delivery.event.BasicExecutionEventListener
getEvents, setFilterEvents

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractReportGenerator

protected AbstractReportGenerator(ReportConfiguration reportConfiguration,
                                  ApplicationContext applicationContext)

Method Detail

getReportConfiguration

public ReportConfiguration getReportConfiguration()

getOutputWriter
```
public Writer getOutputWriter()
```

onEvent
```
public void onEvent(ExecutionEvent executionEvent)
```
Process the ExecutionEvent.

Specified by:

onEvent in interface ExecutionEventListener

Overrides:

onEvent in class BasicExecutionEventListener

Parameters:

executionEvent - The ExecutionEvent.

onAssemblyStarted
```
public void onAssemblyStarted(ExecutionContext executionContext)
```
Specified by:

onAssemblyStarted in interface DOMFilterLifecycle

onProcessingStarted
```
public void onProcessingStarted(ExecutionContext executionContext)
```
Specified by:

onProcessingStarted in interface DOMFilterLifecycle

onSerializationStarted
```
public void onSerializationStarted(ExecutionContext executionContext)
```
Specified by:

onSerializationStarted in interface DOMFilterLifecycle

onPreFilter

public void onPreFilter(ExecutionContext executionContext)

Specified by:: onPreFilter in interface FilterLifecycle

onPostFilter

public void onPostFilter(ExecutionContext executionContext)

Specified by:: onPostFilter in interface FilterLifecycle

ignoreEvent
```
protected boolean ignoreEvent(ExecutionEvent event)
```
Overrides:

ignoreEvent in class BasicExecutionEventListener

processFinishEvent

protected void processFinishEvent(ExecutionContext executionContext)
                           throws IOException

Throws:: IOException

applyTemplate

public abstract void applyTemplate(Report report)
                            throws IOException

Throws:: IOException