JFR8Parameters

Parameter handling in 0.8.10

  • Parameters can only be applied to the master-report.
  • Parameters are always name-value-pairs
  • Multi-Value parameters are provided as arrays (name-value[] pairs)
  • Parameter-values are stored in the report-properties, which are named report-parameters now.

Common Parameter properties

  • Name : String

The name of the parameter identifies the parameter and defines how the parameter is available within the report. The name of the parameter must be unique within the set of parameters.

  • Type : Class

Defines the Java-class for the parameter-value. This is a validation constraint and will be checked by the engine.

  • Default-Value : Object

Defines the default value for a parameter. This value is used to initialize the parameter set, but the user has the chance to undo that by undefining the parameter

  • Mandatory : Boolean

Defines whether <null>-values are allowed for the parameter.

General Parameter types

  • Single-Value parameter

A single primitive free-form entry parameter (within the type-constraints).

  • Single-List-Value parameter

A single-selection parameter that reads the possible values from a data-source. Columns for key and presentation value can be specified. If the parameter is in strict mode, the parameter value must match one of the key-values in the data-model.

  • Multi-List-Value parameter

A multi-selection parameter that reads the possible values from a data-source. Columns for key and presentation value can be specified. If the parameter is in strict mode, the parameter value must match one of the key-values in the data-model.