com.paypal.selion.reports.services

Class ReporterConfigMetadata

java.lang.Object

com.paypal.selion.reports.services.ReporterConfigMetadata

public final class ReporterConfigMetadata
extends Object

This class provides mechanisms to inject metadata in the report that will be used to format the configuration data when the HTML report is rendered. Supported metadata includes the display label for the configuration keys.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISPLAY_LABEL

Method Summary

Modifier and Type	Method and Description
static void	addReporterMetadataItem(String key, String itemType, String value) Adds an new item to the reporter metadata.
static Map<String,Map<String,String>>	getReporterMetaData() Helps retrieve the configuration metadata for the report.
static void	initReporterMetadata() Initialize the report dictionary map with Current Date.
static String	toJsonAsString() This method will generate JSON string representation of the all items in current ReportConfigMetadata.

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_LABEL

public static final String DISPLAY_LABEL

See Also:

Constant Field Values

Method Detail

initReporterMetadata

public static void initReporterMetadata()

Initialize the report dictionary map with Current Date.

addReporterMetadataItem

public static void addReporterMetadataItem(String key,
                                           String itemType,
                                           String value)

Adds an new item to the reporter metadata.

Parameters:

key - - A String that represents the property name contained in JsonRuntimeReporter file.

itemType - - A String that represents the (supported) type of metadata.

value - - A String that represents the reader friendly value to be displayed in the SeLion HTML Reports.

getReporterMetaData

public static Map<String,Map<String,String>> getReporterMetaData()

Helps retrieve the configuration metadata for the report.

Returns:

- A Map that represents the configuration summary.

toJsonAsString

public static String toJsonAsString()

This method will generate JSON string representation of the all items in current ReportConfigMetadata.