com.jivesoftware.base.stats
Class AbstractReport

java.lang.Object
  com.jivesoftware.base.stats.AbstractReport

All Implemented Interfaces:

Report

Direct Known Subclasses:

AbstractForumReport

public abstract class AbstractReport
extends java.lang.Object
implements Report

An abstract base class of Report which offers a default implementation of the interface. Report writers should subclass this class.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.jivesoftware.base.stats.Report

Report.ExtraInfo

Field Summary

protected DateRange	dateRange
protected java.lang.String	description
protected java.lang.String	displayName
protected java.util.Date	endDate
protected java.util.List	histograms
protected java.lang.String	name
protected java.util.List	objects
protected java.util.Map	properties
protected java.util.List	series
protected java.lang.String	shortDescription
protected java.util.Date	startDate

Constructor Summary

AbstractReport()

Method Summary

protected void	addHistogram(Histogram histogram)
void	addSeries(Report report)
abstract void	execute()
Chart[]	getCharts()
DataTable[]	getDataTableCSVs()
DataTable[]	getDataTables()
protected Report.ExtraInfo	getDateRange() Gets the ExtraInfo object for the date range for the report.
java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.util.Date	getEndDate()
java.util.List[]	getExtraInfo()
Histogram[]	getHistograms()
DataTable[]	getImageCSV()
java.lang.String	getName() Returns the name of the report.
java.util.List	getObjects()
java.util.Map	getProperties()
Report[]	getSeries()
java.lang.String	getShortDescription()
java.util.Date	getStartDate()
void	setDateRange(DateRange dateRange)
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setEndDate(java.util.Date date)
void	setName(java.lang.String name)
void	setObjects(java.util.List objects)
void	setShortDescription(java.lang.String shortDescription)
void	setStartDate(java.util.Date startDate)

Methods inherited from class java.lang.Object

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

Field Detail

histograms

protected java.util.List histograms

shortDescription

protected java.lang.String shortDescription

name

protected java.lang.String name

displayName

protected java.lang.String displayName

description

protected java.lang.String description

properties

protected java.util.Map properties

dateRange

protected DateRange dateRange

startDate

protected java.util.Date startDate

endDate

protected java.util.Date endDate

series

protected java.util.List series

objects

protected java.util.List objects

Constructor Detail

AbstractReport

public AbstractReport()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Report

Returns the name of the report.

Specified by:

getName in interface Report

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Report

getShortDescription

public java.lang.String getShortDescription()

Specified by:

getShortDescription in interface Report

setShortDescription

public void setShortDescription(java.lang.String shortDescription)

Specified by:

setShortDescription in interface Report

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface Report

setDisplayName

public void setDisplayName(java.lang.String displayName)

Specified by:

setDisplayName in interface Report

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Report

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Report

execute

public abstract void execute()
                      throws java.lang.Exception

Specified by:

execute in interface Report

Throws:

java.lang.Exception

getProperties

public java.util.Map getProperties()

Specified by:

getProperties in interface Report

getExtraInfo

public java.util.List[] getExtraInfo()

Specified by:

getExtraInfo in interface Report

getSeries

public Report[] getSeries()

Specified by:

getSeries in interface Report

addSeries

public void addSeries(Report report)

getObjects

public java.util.List getObjects()

Specified by:

getObjects in interface Report

setObjects

public void setObjects(java.util.List objects)

Specified by:

setObjects in interface Report

getDataTables

public DataTable[] getDataTables()

Specified by:

getDataTables in interface Report

getDataTableCSVs

public DataTable[] getDataTableCSVs()

Specified by:

getDataTableCSVs in interface Report

getImageCSV

public DataTable[] getImageCSV()

Specified by:

getImageCSV in interface Report

getCharts

public Chart[] getCharts()

Specified by:

getCharts in interface Report

getHistograms

public Histogram[] getHistograms()

Specified by:

getHistograms in interface Report

addHistogram

protected void addHistogram(Histogram histogram)

getStartDate

public java.util.Date getStartDate()

Specified by:

getStartDate in interface Report

setStartDate

public void setStartDate(java.util.Date startDate)

getEndDate

public java.util.Date getEndDate()

Specified by:

getEndDate in interface Report

setEndDate

public void setEndDate(java.util.Date date)

setDateRange

public void setDateRange(DateRange dateRange)

Specified by:

setDateRange in interface Report

getDateRange

protected Report.ExtraInfo getDateRange()

Gets the ExtraInfo object for the date range for the report.

Returns:

the extra info for the "Date Range" key.