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

Classes

class  Field
 

Public Member Functions

 Entry ()
 
void addField (String name, String value)
 
int getNumberOfFields ()
 
String getNameOfFieldAt (int index)
 
String getValueOfFieldAt (int index)
 

Detailed Description

The Entry class defines an event to be included in the report generation.

Each entry contain one or more fields (with a name and value) that detailed/describe the new report entry.

Constructor & Destructor Documentation

◆ Entry()

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

Create a new Entry instance

Member Function Documentation

◆ addField()

void org.esa.s2g.dfdllib.report.Entry.addField ( String  name,
String  value 
)

Add field to detailed/describe the entry

Parameters
namethe name of field to be added
valuethe value of field to be added

◆ getNameOfFieldAt()

String org.esa.s2g.dfdllib.report.Entry.getNameOfFieldAt ( int  index)

Get the name of the field at the given index

If the name of the field starts with "*" the field is mandatory to process/generate the report

Returns
the name of the field at the given index

◆ getNumberOfFields()

int org.esa.s2g.dfdllib.report.Entry.getNumberOfFields ( )

Gets the number of fields contained by the entry

Returns
the number of fields contained by the entry

◆ getValueOfFieldAt()

String org.esa.s2g.dfdllib.report.Entry.getValueOfFieldAt ( int  index)

Get the value of the field at the given index

Returns
the value of the field at the given index; empty string ("") if no value available

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