org.jcon.text

Class IteratingDictionaryReportEngine

java.lang.Object

org.jcon.text.AbstractReportEngine

org.jcon.text.IteratingDictionaryReportEngine

All Implemented Interfaces:

java.io.Serializable, TextReportEngine

public class IteratingDictionaryReportEngine
extends AbstractReportEngine

TextReportEngine that iterates through a Map object, creates a little object with "key" and "value" properties for each pair, and runs the subreport on this pair object.

Author:

Brad Gray

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IteratingDictionaryReportEngine()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBetween() Something to go in between each iteration.
java.util.Comparator	getComparer() Used to sort the keys.
java.lang.String	getFooter() Something for the bottom of this report or section.
java.lang.String	getHeader() Something for the top of this report or section.
TextReportEngine	getSubReport() The report engine to run on each pair in the Map.
void	setBetween(java.lang.String newBetween) Something to go in between each iteration.
void	setComparer(java.util.Comparator newComparer)
void	setFooter(java.lang.String newFooter) Something for the bottom of this report or section.
void	setHeader(java.lang.String newHeader) Something for the top of this report or section.
void	setSubReport(TextReportEngine newReport)
void	writeReport(java.lang.Object source, java.io.PrintWriter printy) Subclasses must implement this - by this time we have a real PrintWriter.

Methods inherited from class org.jcon.text.AbstractReportEngine

generateReportFor, writeReport

Methods inherited from class java.lang.Object

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

Constructor Detail

IteratingDictionaryReportEngine

public IteratingDictionaryReportEngine()

Method Detail

writeReport

public void writeReport(java.lang.Object source,
               java.io.PrintWriter printy)

Description copied from class: AbstractReportEngine

Subclasses must implement this - by this time we have a real PrintWriter.

Specified by:

writeReport in class AbstractReportEngine

getHeader

public java.lang.String getHeader()

Something for the top of this report or section.

setHeader

public void setHeader(java.lang.String newHeader)

Something for the top of this report or section.

getBetween

public java.lang.String getBetween()

Something to go in between each iteration.

setBetween

public void setBetween(java.lang.String newBetween)

Something to go in between each iteration.

getFooter

public java.lang.String getFooter()

Something for the bottom of this report or section.

setFooter

public void setFooter(java.lang.String newFooter)

Something for the bottom of this report or section.

getSubReport

public TextReportEngine getSubReport()

The report engine to run on each pair in the Map. The object given to the subReport is another map with the properties "key" and "value".

setSubReport

public void setSubReport(TextReportEngine newReport)

getComparer

public java.util.Comparator getComparer()

Used to sort the keys.

setComparer

public void setComparer(java.util.Comparator newComparer)