Package org.hortonmachine.gears.utils.simplereport

Class CsvReport

java.lang.Object

org.hortonmachine.gears.utils.simplereport.CsvReport

All Implemented Interfaces:

ISimpleReport

public class CsvReport
extends Object
implements ISimpleReport

An csv report helper.

Author:

Andrea Antonello (www.hydrologis.com)

Constructor Summary

Constructors

Constructor	Description
CsvReport(String separator)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	bold(StringBuilder sb, String text)	Style text as bold.
void	closeReport(StringBuilder sb)	Close the report.
void	closeTable(StringBuilder sb)	Close a table.
void	closeTableCell(StringBuilder sb)	Close a table.
void	closeTableRow(StringBuilder sb)	Close a row.
String	getFileExtension()
void	newLine(StringBuilder sb, int n)	Insert a newline in the report.
void	openReport(StringBuilder sb, String title)	Open the report.
void	openTable(StringBuilder sb, int widthPercentage)	Open a table.
void	openTableCell(StringBuilder sb, String color, String perc, String colSpan, String rowSpan)	Open a table cell.
void	openTableRow(StringBuilder sb)	Open a row.
void	titleH1(StringBuilder sb, String title)	Heading 1 title.
void	titleH2(StringBuilder sb, String title)	Heading 2 title.
void	titleH3(StringBuilder sb, String title)	Heading 3 title.
void	titleH4(StringBuilder sb, String title)	Heading 4 title.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvReport

public CsvReport(String separator)

Constructor.

Parameters:

separator - the separator to use. Default is ",".

Method Detail

getFileExtension

public String getFileExtension()

Specified by:

getFileExtension in interface ISimpleReport

Returns:

the file extention.

newLine

public void newLine(StringBuilder sb,
                    int n)

Description copied from interface: ISimpleReport

Insert a newline in the report.

Specified by:

newLine in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

n - the number of newlines to add.

openReport

public void openReport(StringBuilder sb,
                       String title)

Description copied from interface: ISimpleReport

Open the report.

Specified by:

openReport in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

title - a title for the report.

closeReport

public void closeReport(StringBuilder sb)

Description copied from interface: ISimpleReport

Close the report.

Specified by:

closeReport in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

openTable

public void openTable(StringBuilder sb,
                      int widthPercentage)

Description copied from interface: ISimpleReport

Open a table.

Specified by:

openTable in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

closeTable

public void closeTable(StringBuilder sb)

Description copied from interface: ISimpleReport

Close a table.

Specified by:

closeTable in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

openTableRow

public void openTableRow(StringBuilder sb)

Description copied from interface: ISimpleReport

Open a row.

Specified by:

openTableRow in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

closeTableRow

public void closeTableRow(StringBuilder sb)

Description copied from interface: ISimpleReport

Close a row.

Specified by:

closeTableRow in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

openTableCell

public void openTableCell(StringBuilder sb,
                          String color,
                          String perc,
                          String colSpan,
                          String rowSpan)

Description copied from interface: ISimpleReport

Open a table cell.

Specified by:

openTableCell in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

color - background color for the cell.

perc - percentage of the cell for the width.

colSpan - col span of the cell.

rowSpan - row span of the cell.

closeTableCell

public void closeTableCell(StringBuilder sb)

Description copied from interface: ISimpleReport

Close a table.

Specified by:

closeTableCell in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

titleH1

public void titleH1(StringBuilder sb,
                    String title)

Description copied from interface: ISimpleReport

Heading 1 title.

Specified by:

titleH1 in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

title - the title text.

titleH2

public void titleH2(StringBuilder sb,
                    String title)

Description copied from interface: ISimpleReport

Heading 2 title.

Specified by:

titleH2 in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

title - the title text.

titleH3

public void titleH3(StringBuilder sb,
                    String title)

Description copied from interface: ISimpleReport

Heading 3 title.

Specified by:

titleH3 in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

title - the title text.

titleH4

public void titleH4(StringBuilder sb,
                    String title)

Description copied from interface: ISimpleReport

Heading 4 title.

Specified by:

titleH4 in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

title - the title text.

bold

public void bold(StringBuilder sb,
                 String text)

Description copied from interface: ISimpleReport

Style text as bold.

Specified by:

bold in interface ISimpleReport

Parameters:

sb - the StringBuilder to write to.

text - the text.