DFDL4S (DFDL for Space Library)
Public Member Functions | Static Public Member Functions | List of all members
org.esa.s2g.dfdllib.report.Report Interface Reference

Inherited by org.esa.s2g.dfdllib.report.LocalReport.

Public Member Functions

List< EntrygetEvents ()
 
Entry getSummary ()
 

Static Public Member Functions

static Report report (Document document, ReportProperties properties) throws Exception
 
static Report report (Document document, ReportProperties properties, int begin, int end) throws Exception
 
static Report report (Document document, ReportProperties properties, InterpreterMonitor interpreterMonitor) throws Exception
 
static Report report (Document document, ReportProperties properties, InterpreterMonitor interpreterMonitor, int begin, int end) throws Exception
 

Detailed Description

The Report interface defines the interaction methods related to reporting

The Report is divided in 2 sections:

            1. Summary Entry
                    - The user can add summary into the report (For example: number of isp analysed, the total number o CRC errors found in the isp file, ...)
            2. Event Entry
                    - The user can add events entry into the report. This events should report specific properties of a given element. 
                    (For example: reporting the presence of CRC error in a specific element)

An example of Report usage can be found in S2G client. S2G allow users to generate reports where different type of errors can be detected.

Member Function Documentation

◆ getEvents()

List<Entry> org.esa.s2g.dfdllib.report.Report.getEvents ( )

Return events entries contained in the report

Returns
a list of report Entry events

◆ getSummary()

Entry org.esa.s2g.dfdllib.report.Report.getSummary ( )

Return summary Entry contained in the report

Returns
a summary Entry

◆ report() [1/4]

static Report org.esa.s2g.dfdllib.report.Report.report ( Document  document,
ReportProperties  properties 
) throws Exception
static

Generate the report of the given Document

Parameters
documentthe given document to generate the report
propertiesthe ReportProperties object needed to generate the report
Returns
the Report generated
Exceptions
Exceptionwhen:
  • document is null
  • properties is null

◆ report() [2/4]

static Report org.esa.s2g.dfdllib.report.Report.report ( Document  document,
ReportProperties  properties,
int  begin,
int  end 
) throws Exception
static

Generate the report of the given Document

Parameters
documentthe given document to generate the report
propertiesthe ReportProperties object needed to generate the report
beginthe begin index of the document to generate the report (included)
endthe end index of the document to generate the report (not included)
Returns
the Report generated
Exceptions
Exceptionwhen:
  • document is null
  • properties is null
  • begin or end are negative values
  • begin is bigger or equal to end

◆ report() [3/4]

static Report org.esa.s2g.dfdllib.report.Report.report ( Document  document,
ReportProperties  properties,
InterpreterMonitor  interpreterMonitor 
) throws Exception
static

Generate the report of the given Document

Parameters
documentthe given document to generate the report
propertiesthe properties needed to generate the report
interpreterMonitorthe callback object the that allow the user to register the interpretation/load status of binary data file.
Returns
the Report generated
Exceptions
Exceptionwhen:
  • document is null
  • properties is null

◆ report() [4/4]

static Report org.esa.s2g.dfdllib.report.Report.report ( Document  document,
ReportProperties  properties,
InterpreterMonitor  interpreterMonitor,
int  begin,
int  end 
) throws Exception
static

Generate the report of the given Document

Parameters
documentthe given document to generate the report
propertiesthe properties needed to generate the report
interpreterMonitorthe callback object that allow the user to register the interpretation/load status of binary data file.
beginthe begin index of the document to generate the report (included)
endthe end index of the document to generate the report (not included)
Returns
the Report generated
Exceptions
Exceptionwhen:
  • document is null
  • properties is null
  • begin or end are negative values
  • begin is bigger to end

The documentation for this interface was generated from the following file: