Package org.ametys.web.frontoffice.search.metamodel

Class AdditionalParameterValueMap

java.lang.Object

org.ametys.web.frontoffice.search.metamodel.AdditionalParameterValueMap

Direct Known Subclasses:

MatchingSubprogramSearchComponent.NoSubprogramSearchAdditionalParameterValueMap

public class AdditionalParameterValueMap
extends Object

This class holds the current values of the additional parameters

Field Summary

Fields

Modifier and Type	Field	Description
private Set<String>	_notDisplayableParameterIds
private Map<String,Object>	_values

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AdditionalParameterValueMap(Map<String,Object> values, Set<String> notDisplayableParameterIds)	Builds an AdditionalParameterValueMap

Method Summary

Modifier and Type	Method	Description
String	getDisplayableValue(String parameterId, String defaultValue)	Expert method, for debug purpose, use only if you know what you do Gets the value for display purpose.
Set<String>	getParameterIds()	Gets the parameter ids that have a value
<T> T	getValue(String parameterId)	Gets the value of the given additional parameter

Methods inherited from class java.lang.Object

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

Field Detail

_values

private Map<String,Object> _values

_notDisplayableParameterIds

private Set<String> _notDisplayableParameterIds

Constructor Detail

AdditionalParameterValueMap

protected AdditionalParameterValueMap(Map<String,Object> values,
                                      Set<String> notDisplayableParameterIds)

Builds an AdditionalParameterValueMap

Parameters:

values - The values

notDisplayableParameterIds - The parameter ids which are not displayable to an end-user

Method Detail

getValue

public <T> T getValue(String parameterId)
               throws ClassCastException

Gets the value of the given additional parameter

Type Parameters:

T - the type of the value

Parameters:

parameterId - The id of the parameter

Returns:

the value of the given additional parameter

Throws:

ClassCastException - if the value cannot be cast to the expected type

getParameterIds

public Set<String> getParameterIds()

Gets the parameter ids that have a value

Returns:

the parameter ids that have a value

getDisplayableValue

public String getDisplayableValue(String parameterId,
                                  String defaultValue)

Expert method, for debug purpose, use only if you know what you do
Gets the value for display purpose.

Parameters:

parameterId - The id of the parameter

defaultValue - The value to display if it is not displayable (for security purpose for instance)

Returns:

the value for display purpose.