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.

  • Field Details

  • Constructor Details

  • 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.MetisHTMLTable pControl)
      Create and append a standard empty cell.
      Parameters:
      pControl - the table control

    • makeTotalCell

      public void makeTotalCell(MetisReportHTMLBuilder.MetisHTMLTable pControl)
      Create and append a standard empty total cell.
      Parameters:
      pControl - the table control

    • makeTitleCell

      public void makeTitleCell(MetisReportHTMLBuilder.MetisHTMLTable pControl)
      Create and append a standard empty title cell.
      Parameters:
      pControl - the table control

    • makeValueCell

      public void makeValueCell(MetisReportHTMLBuilder.MetisHTMLTable pControl, Object pValue)
      Create and append a standard cell with value.
      Parameters:
      pControl - the table control
      pValue - the value

    • makeStretchedValueCell

      public void makeStretchedValueCell(MetisReportHTMLBuilder.MetisHTMLTable 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.MetisHTMLTable pControl, Object pValue)
      Create and append a total cell with value.
      Parameters:
      pControl - the table control
      pValue - the value

    • makeStretchedTotalCell

      public void makeStretchedTotalCell(MetisReportHTMLBuilder.MetisHTMLTable 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.MetisHTMLTable pControl, String pTitle)
      Create and append a title cell.
      Parameters:
      pControl - the table control
      pTitle - the title

    • makeStretchedTitleCell

      public void makeStretchedTitleCell(MetisReportHTMLBuilder.MetisHTMLTable 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.MetisHTMLTable pControl, String pLink)
      Make Table link cell.
      Parameters:
      pControl - the table control
      pLink - the link table name

    • makeTableLinkCell

      public void makeTableLinkCell(MetisReportHTMLBuilder.MetisHTMLTable 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.MetisHTMLTable pControl, String pLink)
      Make Delayed Table link cell.
      Parameters:
      pControl - the table control
      pLink - the link table name

    • makeDelayLinkCell

      public void makeDelayLinkCell(MetisReportHTMLBuilder.MetisHTMLTable 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.MetisHTMLTable pControl, String pLink)
      Make Filter link cell.
      Parameters:
      pControl - the table control
      pLink - the link table name

    • makeFilterLinkCell

      public void makeFilterLinkCell(MetisReportHTMLBuilder.MetisHTMLTable 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.MetisHTMLTable 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.MetisHTMLTable pControl)
      Start a table header row.
      Parameters:
      pControl - the table control

    • startRow

      public void startRow(MetisReportHTMLBuilder.MetisHTMLTable pControl)
      Start a table data row.
      Parameters:
      pControl - the table control

    • startTotalRow

      public void startTotalRow(MetisReportHTMLBuilder.MetisHTMLTable 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.MetisHTMLTable startTable(Element pBody)
      Start Table.
      Parameters:
      pBody - the document body
      Returns:
      the table control

    • createEmbeddedTable

      public MetisReportHTMLBuilder.MetisHTMLTable createEmbeddedTable(MetisReportHTMLBuilder.MetisHTMLTable pParent)
      Create an embedded table.
      Parameters:
      pParent - the parent element
      Returns:
      the new table

    • embedTable

      public void embedTable(MetisReportHTMLBuilder.MetisHTMLTable 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.MetisHTMLTable 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