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

Public Member Functions

ReportProperties with (String key, String value)
 
void activateHooks (String evaluateHooks, String firstHeaderPointer)
 

Static Public Member Functions

static ReportProperties buildPropertiesISP (String pathToAPID, String pathToTimeStamp, String idleExpression, String pathToSSC)
 
static ReportProperties buildPropertiesTF (String idleExpression, String pathToVirtualChannelID, String pathToCRCElement, String pathToTFData, String pathToTFHeaderErrorControl, String tfHeaderLength, String tfVirtualChannelFrameCount)
 
static ReportProperties buildPropertiesCADU (String pathToVCDU, String pathToRS, String vcduLength)
 

Detailed Description

This class allows the user to create the properties needed to generate the report for each type of document (ISP, TF and CADU).

Member Function Documentation

◆ activateHooks()

void org.esa.s2g.dfdllib.report.ReportProperties.activateHooks ( String  evaluateHooks,
String  firstHeaderPointer 
)

Activate hooks in report generation

Parameters
evaluateHooksflag indicating that DFDL model hooks should be evaluated 1) null - hooks will not be evaluated 2) otherwise - hook will be evaluated
firstHeaderPointerthe path to the element First Header Pointer (used for showing internal ISP in TF files)

◆ buildPropertiesCADU()

static ReportProperties org.esa.s2g.dfdllib.report.ReportProperties.buildPropertiesCADU ( String  pathToVCDU,
String  pathToRS,
String  vcduLength 
)
static

Build properties necessary to generate report for CADU products.

Parameters
pathToVCDU- Path to VCDU element
pathToRS- Path to RS element
vcduLength- VCDU length
Returns
the properties necessary to generate report for CADU products.

◆ buildPropertiesISP()

static ReportProperties org.esa.s2g.dfdllib.report.ReportProperties.buildPropertiesISP ( String  pathToAPID,
String  pathToTimeStamp,
String  idleExpression,
String  pathToSSC 
)
static

Build properties necessary to generate a complete report for ISP products.

Parameters
pathToAPID- Path to APID element
pathToTimeStamp- Path to TimeStamp element
idleExpression- The expression to evaluate to check for idleness
pathToSSC- Path to SSC element
Returns
the properties necessary to generate a complete report for ISP products.

◆ buildPropertiesTF()

static ReportProperties org.esa.s2g.dfdllib.report.ReportProperties.buildPropertiesTF ( String  idleExpression,
String  pathToVirtualChannelID,
String  pathToCRCElement,
String  pathToTFData,
String  pathToTFHeaderErrorControl,
String  tfHeaderLength,
String  tfVirtualChannelFrameCount 
)
static

Build properties necessary to generate report for TF products.

Parameters
idleExpression- The expression to evaluate to check for idleness
pathToVirtualChannelID- Path to VirtualChannelID element
pathToCRCElement- Path to CRC element
pathToTFData- Path to TF data element
pathToTFHeaderErrorControl- Path to TF HeaderErrorControl element
tfHeaderLength- value of TF header length
tfVirtualChannelFrameCount- Path to TF Virtual Channel Frame Count element
Returns
the properties necessary to generate report for TF products.

◆ with()

ReportProperties org.esa.s2g.dfdllib.report.ReportProperties.with ( String  key,
String  value 
)

Add additional properties to be used in the report generation. Namely, to add more information in the report Entry events.

Parameters
key- The property name/key of an element (name)
value- The value of the element
Returns
the ReportProperties object used with the additional property

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