Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.report

Class MetisReportHTMLBuilder

java.lang.Object

io.github.tonywasher.joceanus.metis.report.MetisReportHTMLBuilder

public class MetisReportHTMLBuilder
extends Object

Build a report document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	MetisReportHTMLBuilder.MetisReportHTMLTable	Table control class.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ATTR_ID	The id attribute.
protected static final String	PFX_OPEN	The open accordion prefix.
protected static final String	REF_DELAY	The delayed reference header.
protected static final String	REF_FILTER	The filter reference header.
protected static final String	REF_ID	The id reference header.
protected static final String	REF_TAB	The table reference header.

Constructor Summary

Constructors

Constructor	Description
MetisReportHTMLBuilder(OceanusDataFormatter pFormatter)	Constructor.

Method Summary

Modifier and Type	Method	Description
MetisReportHTMLBuilder.MetisReportHTMLTable	createEmbeddedTable(MetisReportHTMLBuilder.MetisReportHTMLTable pParent)	Create an embedded table.
void	embedTable(MetisReportHTMLBuilder.MetisReportHTMLTable pTable)	Embed a table into the document.
void	embedTable(MetisReportHTMLBuilder.MetisReportHTMLTable pTable, String pTitle)	Embed a table into the document.
OceanusDataFormatter	getDataFormatter()	Obtain the data formatter.
Document	getDocument()	Obtain the document.
protected Element	getLinkRow(String pTitle)	Obtain the row that a link is in.
void	makeDelayLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pLink)	Make Delayed Table link cell.
void	makeDelayLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pLink, String pName)	Make Delayed Table link cell.
void	makeFilterLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pLink)	Make Filter link cell.
void	makeFilterLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pLink, Object pValue)	Make Table link cell.
void	makeFilterLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pLink, String pName)	Make Table link cell.
void	makeStretchedTitleCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pTitle)	Create and append a standard title cell with title spanning 2 columns.
void	makeStretchedTotalCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, Object pValue)	Create and append a standard total cell with value spanning 2 columns.
void	makeStretchedValueCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, Object pValue)	Create and append a standard cell with value spanning 2 columns.
void	makeSubTitle(Element pBody, String pTitle)	Make subtitle.
void	makeTableLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pLink)	Make Table link cell.
void	makeTableLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pLink, String pName)	Make Table link cell.
void	makeTitle(Element pBody, String pTitle)	Make title.
void	makeTitle(Element pBody, String pTitle1, String pTitle2)	Make two line title.
void	makeTitleCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)	Create and append a standard empty title cell.
void	makeTitleCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, String pTitle)	Create and append a title cell.
void	makeTotalCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)	Create and append a standard empty total cell.
void	makeTotalCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, Object pValue)	Create and append a total cell with value.
void	makeValueCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)	Create and append a standard empty cell.
void	makeValueCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl, Object pValue)	Create and append a standard cell with value.
(package private) void	setPrefix(Node pOwner, boolean pOpen)	Set prefix for owning link.
void	startHdrRow(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)	Start a table header row.
Element	startReport()	Start Report.
void	startRow(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)	Start a table data row.
MetisReportHTMLBuilder.MetisReportHTMLTable	startTable(Element pBody)	Start Table.
void	startTotalRow(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)	Start a table total row.

Methods inherited from class java.lang.Object

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

Field Details

ATTR_ID

protected static final String ATTR_ID

The id attribute.

See Also:

• Constant Field Values

REF_TAB

protected static final String REF_TAB

The table reference header.

See Also:

• Constant Field Values

REF_ID

protected static final String REF_ID

The id reference header.

See Also:

• Constant Field Values

REF_FILTER

protected static final String REF_FILTER

The filter reference header.

See Also:

• Constant Field Values

REF_DELAY

protected static final String REF_DELAY

The delayed reference header.

See Also:

• Constant Field Values

PFX_OPEN

protected static final String PFX_OPEN

The open accordion prefix.

See Also:

• Constant Field Values

Constructor Details

MetisReportHTMLBuilder

public MetisReportHTMLBuilder(OceanusDataFormatter pFormatter)
                       throws OceanusException

Constructor.

Parameters:

pFormatter - the formatter

Throws:

OceanusException - on error

Method Details

getDataFormatter

public OceanusDataFormatter getDataFormatter()

Obtain the data formatter.

Returns:

the formatter

getDocument

public Document getDocument()

Obtain the document.

Returns:

the document

makeValueCell

public void makeValueCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)

Create and append a standard empty cell.

Parameters:

pControl - the table control

makeTotalCell

public void makeTotalCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)

Create and append a standard empty total cell.

Parameters:

pControl - the table control

makeTitleCell

public void makeTitleCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)

Create and append a standard empty title cell.

Parameters:

pControl - the table control

makeValueCell

public void makeValueCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 Object pValue)

Create and append a standard cell with value.

Parameters:

pControl - the table control

pValue - the value

makeStretchedValueCell

public void makeStretchedValueCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 Object pValue)

Create and append a standard cell with value spanning 2 columns.

Parameters:

pControl - the table control

pValue - the value

makeTotalCell

public void makeTotalCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 Object pValue)

Create and append a total cell with value.

Parameters:

pControl - the table control

pValue - the value

makeStretchedTotalCell

public void makeStretchedTotalCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 Object pValue)

Create and append a standard total cell with value spanning 2 columns.

Parameters:

pControl - the table control

pValue - the value

makeTitleCell

public void makeTitleCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pTitle)

Create and append a title cell.

Parameters:

pControl - the table control

pTitle - the title

makeStretchedTitleCell

public void makeStretchedTitleCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pTitle)

Create and append a standard title cell with title spanning 2 columns.

Parameters:

pControl - the table control

pTitle - the title

makeTableLinkCell

public void makeTableLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pLink)

Make Table link cell.

Parameters:

pControl - the table control

pLink - the link table name

makeTableLinkCell

public void makeTableLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pLink,
 String pName)

Make Table link cell.

Parameters:

pControl - the table control

pLink - the link table name

pName - the link table display name

makeDelayLinkCell

public void makeDelayLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pLink)

Make Delayed Table link cell.

Parameters:

pControl - the table control

pLink - the link table name

makeDelayLinkCell

public void makeDelayLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pLink,
 String pName)

Make Delayed Table link cell.

Parameters:

pControl - the table control

pLink - the link table name

pName - the link table display name

makeFilterLinkCell

public void makeFilterLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pLink)

Make Filter link cell.

Parameters:

pControl - the table control

pLink - the link table name

makeFilterLinkCell

public void makeFilterLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pLink,
 String pName)

Make Table link cell.

Parameters:

pControl - the table control

pLink - the link table name

pName - the link table display name

makeFilterLinkCell

public void makeFilterLinkCell(MetisReportHTMLBuilder.MetisReportHTMLTable pControl,
 String pLink,
 Object pValue)

Make Table link cell.

Parameters:

pControl - the table control

pLink - the link table name

pValue - the link table display value

startHdrRow

public void startHdrRow(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)

Start a table header row.

Parameters:

pControl - the table control

startRow

public void startRow(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)

Start a table data row.

Parameters:

pControl - the table control

startTotalRow

public void startTotalRow(MetisReportHTMLBuilder.MetisReportHTMLTable pControl)

Start a table total row.

Parameters:

pControl - the table control

startReport

public Element startReport()

Start Report.

Returns:

the body

makeTitle

public void makeTitle(Element pBody,
 String pTitle)

Make title.

Parameters:

pBody - the document body

pTitle - the title

makeTitle

public void makeTitle(Element pBody,
 String pTitle1,
 String pTitle2)

Make two line title.

Parameters:

pBody - the document body

pTitle1 - the first title

pTitle2 - the second title

makeSubTitle

public void makeSubTitle(Element pBody,
 String pTitle)

Make subtitle.

Parameters:

pBody - the document body

pTitle - the title

startTable

public MetisReportHTMLBuilder.MetisReportHTMLTable startTable(Element pBody)

Start Table.

Parameters:

pBody - the document body

Returns:

the table control

createEmbeddedTable

public MetisReportHTMLBuilder.MetisReportHTMLTable createEmbeddedTable(MetisReportHTMLBuilder.MetisReportHTMLTable pParent)

Create an embedded table.

Parameters:

pParent - the parent element

Returns:

the new table

embedTable

public void embedTable(MetisReportHTMLBuilder.MetisReportHTMLTable pTable,
 String pTitle)

Embed a table into the document.

Parameters:

pTable - the table to embed

pTitle - the title of the table

embedTable

public void embedTable(MetisReportHTMLBuilder.MetisReportHTMLTable pTable)

Embed a table into the document.

Parameters:

pTable - the table to embed

getLinkRow

protected Element getLinkRow(String pTitle)

Obtain the row that a link is in.

Parameters:

pTitle - the title of the link

Returns:

the row that contains the link

setPrefix

void setPrefix(Node pOwner,
 boolean pOpen)

Set prefix for owning link.

Parameters:

pOwner - the owning link

pOpen - is the link open true/false