Package org.smooks.engine.report

Class AbstractReportGenerator

java.lang.Object

org.smooks.engine.delivery.event.BasicExecutionEventListener

org.smooks.engine.report.AbstractReportGenerator

All Implemented Interfaces:

org.smooks.api.delivery.event.ExecutionEventListener, org.smooks.api.lifecycle.DOMFilterLifecycle, org.smooks.api.lifecycle.FilterLifecycle

Direct Known Subclasses:

FlatReportGenerator, HtmlReportGenerator

public abstract class AbstractReportGenerator
extends BasicExecutionEventListener
implements org.smooks.api.lifecycle.FilterLifecycle, org.smooks.api.lifecycle.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, org.smooks.api.ApplicationContext applicationContext)

Method Summary

Modifier and Type	Method	Description
abstract void	applyTemplate(Report report)
Writer	getOutputWriter()
ReportConfiguration	getReportConfiguration()
protected boolean	ignoreEvent(org.smooks.api.delivery.event.ExecutionEvent event)
void	onAssemblyStarted(org.smooks.api.ExecutionContext executionContext)
void	onEvent(org.smooks.api.delivery.event.ExecutionEvent executionEvent)	Process the ExecutionEvent.
void	onPostFilter(org.smooks.api.ExecutionContext executionContext)
void	onPreFilter(org.smooks.api.ExecutionContext executionContext)
void	onProcessingStarted(org.smooks.api.ExecutionContext executionContext)
void	onSerializationStarted(org.smooks.api.ExecutionContext executionContext)
protected void	processFinishEvent(org.smooks.api.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,
                                  org.smooks.api.ApplicationContext applicationContext)

Method Detail

getReportConfiguration

public ReportConfiguration getReportConfiguration()

getOutputWriter

public Writer getOutputWriter()

onEvent

public void onEvent(org.smooks.api.delivery.event.ExecutionEvent executionEvent)

Process the ExecutionEvent.

Specified by:

onEvent in interface org.smooks.api.delivery.event.ExecutionEventListener

Overrides:

onEvent in class BasicExecutionEventListener

Parameters:

executionEvent - The ExecutionEvent.

onAssemblyStarted

public void onAssemblyStarted(org.smooks.api.ExecutionContext executionContext)

Specified by:

onAssemblyStarted in interface org.smooks.api.lifecycle.DOMFilterLifecycle

onProcessingStarted

public void onProcessingStarted(org.smooks.api.ExecutionContext executionContext)

Specified by:

onProcessingStarted in interface org.smooks.api.lifecycle.DOMFilterLifecycle

onSerializationStarted

public void onSerializationStarted(org.smooks.api.ExecutionContext executionContext)

Specified by:

onSerializationStarted in interface org.smooks.api.lifecycle.DOMFilterLifecycle

onPreFilter

public void onPreFilter(org.smooks.api.ExecutionContext executionContext)

Specified by:

onPreFilter in interface org.smooks.api.lifecycle.FilterLifecycle

onPostFilter

public void onPostFilter(org.smooks.api.ExecutionContext executionContext)

Specified by:

onPostFilter in interface org.smooks.api.lifecycle.FilterLifecycle

ignoreEvent

protected boolean ignoreEvent(org.smooks.api.delivery.event.ExecutionEvent event)

Overrides:

ignoreEvent in class BasicExecutionEventListener

processFinishEvent

protected void processFinishEvent(org.smooks.api.ExecutionContext executionContext)
                           throws IOException

Throws:

IOException

applyTemplate

public abstract void applyTemplate(Report report)
                            throws IOException

Throws:

IOException