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

public class ParametersManager
extends AbstractLogEnabled
implements Component

Manager to handle parameters

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	_PARAM_UNTOUCHED_BINARY	Constant for untouched binary metadata.
static 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 Map<String,DefinitionAndValue>	_getBrothersDefinitionAndValues(String prefix, Map<String,Object> values, ElementDefinition definition)	Get the definition and value pairs of the given definition brothers.
protected boolean	_hasParameterValueOrDefaultValue(String parameterPath, ModelAwareDataHolder dataHolder, Object defaultValue)	True if the parameter has a value or a default value
protected void	_moveRepeaterEntries(ModifiableModelAwareRepeater repeater, Map<String,Object> values, String repeaterPath)	Moves the repeater entries according to the given values.
protected void	_setParameterValues(ModelItem def, Map<String,Object> values, ModifiableModelAwareDataHolder dataHolder, String prefix, Map<String,List<I18nizableText>> allErrors)	Set parameters values of the model item
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
Map<String,List<I18nizableText>>	setParameterValues(ModifiableModelAwareDataHolder dataHolder, Collection<? extends ModelItem> modelItems, Map<String,Object> values)	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 Detail

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

Constructor Detail

ParametersManager

public ParametersManager()

Method Detail

setParameterValues

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

Set parameters values to the data holder for each model items

Parameters:

dataHolder - the data holder

modelItems - the list of model items

values - the values

Returns:

the map of possible errors

_setParameterValues

protected void _setParameterValues(ModelItem def,
                                   Map<String,Object> values,
                                   ModifiableModelAwareDataHolder dataHolder,
                                   String prefix,
                                   Map<String,List<I18nizableText>> allErrors)

Set parameters values of the model item

Parameters:

def - the model item definition

values - the value

dataHolder - the data holder

prefix - the prefix to get the parameter values

allErrors - the map of possible errors

_getBrothersDefinitionAndValues

protected Map<String,DefinitionAndValue> _getBrothersDefinitionAndValues(String prefix,
                                                                               Map<String,Object> values,
                                                                               ElementDefinition definition)

Get the definition and value pairs of the given definition brothers. The definition and value pairs are indexed by the parameter name

Parameters:

prefix - prefix to get the parameter values

values - all the parameter values

definition - the definition

Returns:

the definition and value pairs of the given definition brother

_moveRepeaterEntries

protected void _moveRepeaterEntries(ModifiableModelAwareRepeater repeater,
                                    Map<String,Object> values,
                                    String repeaterPath)

Moves the repeater entries according to the given values. Removes or add entries if needed. After the call of this method, the given repeater will contain the right entries

Parameters:

repeater - the repeater

values - the values

repeaterPath - the repeater path

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