Package org.ametys.web.parameters

Class ParametersManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.parameters.ParametersManager

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ParametersManager
extends AbstractLogEnabled
implements Component, Serviceable

Manager to handle parameters

Field Summary

Fields

Modifier and Type	Field	Description
protected DisableConditionsEvaluator<ModelAwareDataHolder>	_disableConditionsEvaluator	The disable conditions evaluator
protected static final String	_PARAM_METADATA_PREFIX	Prefix for HTML form elements.
protected static final String	_PARAM_UNTOUCHED_BINARY	Constant for untouched binary metadata.
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
ParametersManager()

Method Summary

Modifier and Type	Method	Description
protected void	_addParameterValues(ModelItem item, ModelAwareDataHolder dataHolder, String prefix, Map<String,Object> values)	Add the parameter values to all values
protected boolean	_hasParameterValueOrDefaultValue(String parameterPath, ModelAwareDataHolder dataHolder, Object defaultValue)	True if the parameter has a value or a default value
protected Map<String,Object>	_parseValues(Collection<? extends ModelItem> modelItems, Map<String,Object> rawValues, String prefix)	Parses the given raw values
protected Map<String,List<I18nizableText>>	_setParameterValues(Collection<? extends ModelItem> modelItems, Map<String,Object> currentValues, Map<String,Object> allValues, ModifiableModelAwareDataHolder dataHolder, String prefix)	Set parameters values of the model items
Map<String,Object>	addPrefixToParameters(Map<String,Object> parameterValues, String prefix)	Add prefix to all parameters
Map<String,Object>	getParametersStartWithPrefix(Map<String,Object> parameterValues, String prefix)	Get all parameters which start with prefix and change the name of the attribute removing this prefix
Map<String,Object>	getParametersValues(Collection<? extends ModelItem> items, ModelAwareDataHolder dataHolder, String prefix)	Get the parameters values
List<Map<String,Object>>	getRepeatersValues(Collection<ModelItem> items, ModelAwareDataHolder dataHolder, String prefix)	Get the repeaters values
void	service(ServiceManager manager)
Map<String,List<I18nizableText>>	setParameterValues(ModifiableModelAwareDataHolder dataHolder, Collection<? extends ModelItem> modelItems, Map<String,Object> rawValues)	Set parameters values to the data holder for each model items

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

_PARAM_UNTOUCHED_BINARY

protected static final String _PARAM_UNTOUCHED_BINARY

Constant for untouched binary metadata.

See Also:

• Constant Field Values

_PARAM_METADATA_PREFIX

protected static final String _PARAM_METADATA_PREFIX

Prefix for HTML form elements.

See Also:

• Constant Field Values

_disableConditionsEvaluator

protected DisableConditionsEvaluator<ModelAwareDataHolder> _disableConditionsEvaluator

The disable conditions evaluator

Constructor Details

ParametersManager

public ParametersManager()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setParameterValues

public Map<String,List<I18nizableText>> setParameterValues(ModifiableModelAwareDataHolder dataHolder,
 Collection<? extends ModelItem> modelItems,
 Map<String,Object> rawValues)

Set parameters values to the data holder for each model items

Parameters:

dataHolder - the data holder

modelItems - the list of model items

rawValues - the values

Returns:

the map of possible errors

_parseValues

protected Map<String,Object> _parseValues(Collection<? extends ModelItem> modelItems,
 Map<String,Object> rawValues,
 String prefix)

Parses the given raw values

Parameters:

modelItems - the model items corresponding to the given values

rawValues - the raw values

prefix - the current prefix for data to parse

Returns:

the parsed values

_setParameterValues

protected Map<String,List<I18nizableText>> _setParameterValues(Collection<? extends ModelItem> modelItems,
 Map<String,Object> currentValues,
 Map<String,Object> allValues,
 ModifiableModelAwareDataHolder dataHolder,
 String prefix)

Set parameters values of the model items

Parameters:

modelItems - the model items

currentValues - the values to set for the current model items

allValues - the value all values to set

dataHolder - the data holder

prefix - the prefix to get the parameter values

Returns:

the map of possible errors

getParametersValues

public Map<String,Object> getParametersValues(Collection<? extends ModelItem> items,
 ModelAwareDataHolder dataHolder,
 String prefix)

Get the parameters values

Parameters:

items - the list of model item

dataHolder - the data holder

prefix - prefix to get the parameter values

Returns:

the parameters values

_addParameterValues

protected void _addParameterValues(ModelItem item,
 ModelAwareDataHolder dataHolder,
 String prefix,
 Map<String,Object> values)

Add the parameter values to all values

Parameters:

item - the model item

dataHolder - the data holder

prefix - prefix to get the parameter values

values - all the values

getRepeatersValues

public List<Map<String,Object>> getRepeatersValues(Collection<ModelItem> items,
 ModelAwareDataHolder dataHolder,
 String prefix)

Get the repeaters values

Parameters:

items - the list of model item

dataHolder - the data holder

prefix - prefix to get the parameter values

Returns:

the repeaters values

_hasParameterValueOrDefaultValue

protected boolean _hasParameterValueOrDefaultValue(String parameterPath,
 ModelAwareDataHolder dataHolder,
 Object defaultValue)

True if the parameter has a value or a default value

Parameters:

parameterPath - the parameter path

dataHolder - the data holder

defaultValue - the default value

Returns:

true if the parameter has a value or a default value

getParametersStartWithPrefix

public Map<String,Object> getParametersStartWithPrefix(Map<String,Object> parameterValues,
 String prefix)

Get all parameters which start with prefix and change the name of the attribute removing this prefix

Parameters:

parameterValues - the parameter values

prefix - the prefix

Returns:

the map of filtered parameters

addPrefixToParameters

public Map<String,Object> addPrefixToParameters(Map<String,Object> parameterValues,
 String prefix)

Add prefix to all parameters

Parameters:

parameterValues - the parameters values

prefix - the prefix

Returns:

the map of parameters with its prefix