com.ebay.carad.os.vitalsigns.listeners
Class IndexWritingListener

java.lang.Object
  com.ebay.carad.os.vitalsigns.listeners.AbstractReportingListener
      com.ebay.carad.os.vitalsigns.listeners.IndexWritingListener

All Implemented Interfaces:

IReportingListener

public class IndexWritingListener
extends AbstractReportingListener

Used for writing any kind of index to the reports that were ran. It stores reports internally as each is ran, and then when reportingComplete is called, it generates its output based on the Freemarker template provided.

Version:

$Id$

Author:

Jeremy Thomerson

Field Summary

private static org.apache.log4j.Logger	LOGGER
private java.lang.String	mRelativeOutputPath
private java.lang.String	mTemplatePath
private ITemplateProcessor	mTemplateProcessor

Constructor Summary

IndexWritingListener()

Method Summary

java.lang.String	getRelativeOutputPath()
java.lang.String	getTemplatePath()
void	reportingComplete(IDashboardAgent agent)
void	setRelativeOutputPath(java.lang.String relativeOutputPath)
void	setTemplatePath(java.lang.String templatePath)

Methods inherited from class com.ebay.carad.os.vitalsigns.listeners.AbstractReportingListener

reportingException, reportingPreStart, reportRan

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

private static final org.apache.log4j.Logger LOGGER

mTemplateProcessor

private ITemplateProcessor mTemplateProcessor

mRelativeOutputPath

private java.lang.String mRelativeOutputPath

mTemplatePath

private java.lang.String mTemplatePath

Constructor Detail

IndexWritingListener

public IndexWritingListener()

Method Detail

reportingComplete

public void reportingComplete(IDashboardAgent agent)

Specified by:

reportingComplete in interface IReportingListener

Overrides:

reportingComplete in class AbstractReportingListener

getTemplatePath

public java.lang.String getTemplatePath()

setTemplatePath

public void setTemplatePath(java.lang.String templatePath)

Parameters:

templatePath - The path to the template on the classpath.

getRelativeOutputPath

public java.lang.String getRelativeOutputPath()

setRelativeOutputPath

public void setRelativeOutputPath(java.lang.String relativeOutputPath)

Parameters:

relativeOutputPath - The path that the output should be written to, relative to the report agent destination path