Class JSONReport


  • public class JSONReport
    extends Report
    This class represents a full report in JSON format.
    Author:
    mcayanan
    • Constructor Detail

      • JSONReport

        public JSONReport()
    • Method Detail

      • setOutput

        public void setOutput​(Writer writer)
        Handles writing a Report to the writer interface. This is is useful if someone would like to put the contents of the Report to something such as StringWriter.
        Overrides:
        setOutput in class Report
        Parameters:
        writer - which the report will be written to
      • setOutput

        public void setOutput​(OutputStream os)
        Handle writing a Report to an OutputStream. This is useful to get the report to print to something such as System.out
        Overrides:
        setOutput in class Report
        Parameters:
        os - stream which the report will be written to
      • setOutput

        public void setOutput​(File file)
                       throws IOException
        Handles writing a Report to a File.
        Overrides:
        setOutput in class Report
        Parameters:
        file - which the report will output to
        Throws:
        IOException - if there is an issue in writing the report to the file
      • printHeader

        public void printHeader()
        Description copied from class: Report
        This method will display the default header for the Vtool command line library reports. This is the standard header across all reports.
        Overrides:
        printHeader in class Report
      • printHeader

        protected void printHeader​(PrintWriter writer,
                                   String title)
        Description copied from class: Report
        Allows a Report to customize the header portion of the Report if necessary.
        Specified by:
        printHeader in class Report
        Parameters:
        writer - passed down to write header contents to
      • printRecordMessages

        protected void printRecordMessages​(PrintWriter writer,
                                           Status status,
                                           URI sourceUri,
                                           List<ValidationProblem> problems)
        Description copied from class: Report
        Allows a report to customize how it handles reporting on a particular label.
        Specified by:
        printRecordMessages in class Report
        Parameters:
        writer - passed on to write customized messages to
        sourceUri - reference to the file that is being reported on
        problems - which to report on for this source
      • printFooter

        protected void printFooter​(PrintWriter writer)
        Description copied from class: Report
        Allows customization of the footer section of the report
        Specified by:
        printFooter in class Report
        Parameters:
        writer - passed on to writer customized footer contents
      • printFooter

        public void printFooter()
        Description copied from class: Report
        Prints out the footer or the report and calls the customized footer section.
        Overrides:
        printFooter in class Report