Package io.jmix.reports.runner

Class ReportInputParameterValidator

java.lang.Object

io.jmix.reports.runner.ReportInputParameterValidator

@Component("report_ReportInputParameterValidator")
public class ReportInputParameterValidator
extends Object

Validates report input parameters before running the report. Used by any code that runs a report on behalf of an external caller (e.g. UI or REST API) to check parameter values the same way, so a report is not executed with invalid input.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ReportsGroovyFeatureSupport	groovyFeatureSupport
protected final GroovyScriptParametersProvider	groovyScriptParametersProvider
protected final Messages	messages
protected final Scripting	scripting

Constructor Summary

Constructors

Constructor	Description
ReportInputParameterValidator(GroovyScriptParametersProvider groovyScriptParametersProvider, Scripting scripting, ReportsGroovyFeatureSupport groovyFeatureSupport, Messages messages)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createScriptContext(Map<String,Object> contextParameters)
void	crossValidateParameters(Report report, Map<String,Object> reportParameters)	Performs cross field parameters validation before running the report.
protected void	runCrossValidationDelegate(ParametersCrossValidator crossValidator, Map<String,Object> reportParameters)
protected void	runValidationDelegate(ParameterValidator validator, Object value)
protected void	runValidationScript(String groovyScript, Map<String,Object> scriptContext)
void	validateParameterValue(ReportInputParameter parameter, Object value)	Checking validation for an input parameter field before running the report.
protected void	wrapValidation(Runnable validator)

Methods inherited from class java.lang.Object

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

Field Details

groovyScriptParametersProvider

protected final GroovyScriptParametersProvider groovyScriptParametersProvider

scripting

protected final Scripting scripting

groovyFeatureSupport

protected final ReportsGroovyFeatureSupport groovyFeatureSupport

messages

protected final Messages messages

Constructor Details

ReportInputParameterValidator

public ReportInputParameterValidator(GroovyScriptParametersProvider groovyScriptParametersProvider,
 Scripting scripting,
 ReportsGroovyFeatureSupport groovyFeatureSupport,
 Messages messages)

Method Details

validateParameterValue

public void validateParameterValue(ReportInputParameter parameter,
 Object value)

Checking validation for an input parameter field before running the report.

Parameters:

parameter - data info which describes report's parameter

value - parameter's value

crossValidateParameters

public void crossValidateParameters(Report report,
 Map<String,Object> reportParameters)

Performs cross field parameters validation before running the report.

Parameters:

report - report instance

reportParameters - map of parameters values taken from components

runValidationScript

protected void runValidationScript(String groovyScript,
 Map<String,Object> scriptContext)

wrapValidation

protected void wrapValidation(Runnable validator)

runCrossValidationDelegate

protected void runCrossValidationDelegate(ParametersCrossValidator crossValidator,
 Map<String,Object> reportParameters)

runValidationDelegate

protected void runValidationDelegate(ParameterValidator validator,
 Object value)

createScriptContext

protected Map<String,Object> createScriptContext(Map<String,Object> contextParameters)