Package noaa.coastwatch.util

Interface ReportFormatter

All Known Implementing Classes:
HTMLReportFormatter, TextReportFormatter
public interface ReportFormatter
The ReportFormatter class is an interface for formatting reports of text data.
Since:
3.7.1
Author:
Peter Hollemans

  • Method Details

    • start

      void start()
      Starts the report.

    • title

      void title(String text)
      Formats a report title.
      Parameters:
      text - the title of the report.

    • section

      void section(String title)
      Formats a section header.
      Parameters:
      title - the title of the section.

    • paragraph

      void paragraph(String text)
      Formats a paragraph.
      Parameters:
      text - the text of the paragraph.

    • line

      void line(String text)
      Formats a single line.
      Parameters:
      text - the text of the line.

    • table

      void table(String[] columns, List<String[]> rows)
      Formats a table.
      Parameters:
      columns - the column names.
      rows - the list of row data values.

    • table

      void table(String[] columns, Map<String,List<String[]>> rowMap)
      Formats a table with multiple sections.
      Parameters:
      columns - the column names.
      rowMap - the map of section names to row data values.

    • map

      void map(Map<String,String> map)
      Formats a map of keys to values as a table with two columns.
      Parameters:
      map - the map of keys to values.

    • end

      void end()
      Ends the report.