gov.nasa.pds.citool.report

Class IngestReport

java.lang.Object

gov.nasa.pds.citool.report.Report

gov.nasa.pds.citool.report.IngestReport

public class IngestReport
extends Report

This class represents a full report for the Vtool command line. This is the standard report that will display all problems generated for every file that was inspected. Messages are grouped at the file level and then summarized at the end.

Author:

pramirez

Field Summary

Fields inherited from class gov.nasa.pds.citool.report.Report

configurations, parameters

Constructor Summary

Constructors

Constructor and Description
IngestReport()

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(String[] args)
protected void	printFooter(PrintWriter writer) Allows customization of the footer section of the report
protected void	printHeader(PrintWriter writer) Allows a Report to customize the header portion of the Report if necessary.
protected void	printRecordMessages(PrintWriter writer, Status status, List<String> sourceUris, List<gov.nasa.pds.tools.LabelParserException> problems)
protected void	printRecordMessages(PrintWriter writer, Status status, URI sourceUri, List<gov.nasa.pds.tools.LabelParserException> problems) Allows a report to customize how it handles reporting on a particular label.
void	printRecordSkip(PrintWriter writer, URI sourceUri, Exception exception)
void	setPrintDetails(boolean print)

Methods inherited from class gov.nasa.pds.citool.report.Report

addConfiguration, addParameter, filterProblems, getLevel, getNumFailed, getNumPassed, getNumSkipped, getOutput, getTotalErrors, getTotalInfos, getTotalWarnings, hasErrors, hasWarnings, printFooter, printHeader, printRecordSkip, record, record, record, recordSkip, recordSkip, setLevel, setOutput, setOutput, setOutput

Methods inherited from class java.lang.Object

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

Constructor Detail

IngestReport

public IngestReport()

Method Detail

setPrintDetails

public void setPrintDetails(boolean print)

printHeader

protected void printHeader(PrintWriter writer)

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<gov.nasa.pds.tools.LabelParserException> 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

printRecordSkip

public void printRecordSkip(PrintWriter writer,
                   URI sourceUri,
                   Exception exception)

Overrides:

printRecordSkip in class Report

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

printRecordMessages

protected void printRecordMessages(PrintWriter writer,
                       Status status,
                       List<String> sourceUris,
                       List<gov.nasa.pds.tools.LabelParserException> problems)

Specified by:

printRecordMessages in class Report