org.ametys.runtime.parameter

Class AbstractParameterParser<P extends Parameter<T>,T extends Enum<T>>

java.lang.Object

org.ametys.runtime.parameter.AbstractParameterParser<P,T>

Type Parameters:

P - the actual type of parameter.

T - the actual type of parameter type.

Direct Known Subclasses:

AbstractStaticSchedulable.SchedulableParameterParser, ConfigParameterParser, CredentialProviderFactory.CredentialProviderModelParameterParser, DefaultContentType.MetadataAndRepeaterDefinitionParser, GroupDirectoryFactory.GroupDirectoryModelParameterParser, JdbcUserDirectory.JdbcParameterParser, SiteConfigurationExtensionPoint.SiteParameterParser, SkinConfigurationAction.SkinParameterParser, StaticService.ServiceParameterParser, StaticUserPreferenceProvider.UserPreferenceParser, SynchronizeContentsCollectionModelExtensionPoint.SynchronizableContentsCollectionModelParameterParser, UserDirectoryFactory.UserDirectoryModelParameterParser

public abstract class AbstractParameterParser<P extends Parameter<T>,T extends Enum<T>>
extends Object

Parameter parser from an XML configuration.

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	__LOGGER
protected ThreadSafeComponentManager<Enumerator>	_enumeratorManager The enumerators component manager.
private Map<P,String>	_enumeratorsToLookup
protected ThreadSafeComponentManager<Validator>	_validatorManager The validators component manager.
private Map<P,String>	_validatorsToLookup

Constructor Summary

Constructors

Constructor and Description
AbstractParameterParser(ThreadSafeComponentManager<Enumerator> enumeratorManager, ThreadSafeComponentManager<Validator> validatorManager) Creates an AbstractParameterParser.

Method Summary

Modifier and Type	Method and Description
protected void	_additionalParsing(ServiceManager manager, String pluginName, Configuration parameterConfig, String parameterId, P parameter) Called for additional parsing. Default implementation does nothing.
protected abstract P	_createParameter(Configuration parameterConfig) Create the parameter to populate it.
protected void	_parseAndSetEnumerator(String pluginName, P parameter, String parameterId, Configuration parameterConfig) Parses the enumerator.
protected void	_parseAndSetValidator(String pluginName, P parameter, String parameterId, Configuration parameterConfig) Parses the validator.
protected abstract Object	_parseDefaultValue(Configuration parameterConfig, P parameter) Parses the default value.
protected I18nizableText	_parseI18nizableText(Configuration config, String pluginName, String name) Parses an i18n text.
protected abstract String	_parseId(Configuration parameterConfig) Parses the id.
protected abstract T	_parseType(Configuration parameterConfig) Parses the type.
protected String	_parseWidget(Configuration parameterConfig) Parses the widget.
protected Map<String,I18nizableText>	_parseWidgetParameters(Configuration parameterConfig, String pluginName) Parses the widget's parameters
void	lookupComponents() Retrieves local validators and enumerators components and set them into previous parameter parsed.
P	parseParameter(ServiceManager manager, String pluginName, Configuration parameterConfig) Parses a parameter from a XML configuration.

Methods inherited from class java.lang.Object

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

Field Detail

__LOGGER

private static final Logger __LOGGER

_enumeratorManager

protected ThreadSafeComponentManager<Enumerator> _enumeratorManager

The enumerators component manager.

_validatorManager

protected ThreadSafeComponentManager<Validator> _validatorManager

The validators component manager.

_validatorsToLookup

private final Map<P extends Parameter<T>,String> _validatorsToLookup

_enumeratorsToLookup

private final Map<P extends Parameter<T>,String> _enumeratorsToLookup

Constructor Detail

AbstractParameterParser

public AbstractParameterParser(ThreadSafeComponentManager<Enumerator> enumeratorManager,
                               ThreadSafeComponentManager<Validator> validatorManager)

Creates an AbstractParameterParser.

Parameters:

enumeratorManager - the enumerator component manager.

validatorManager - the validator component manager.

Method Detail

parseParameter

public P parseParameter(ServiceManager manager,
                        String pluginName,
                        Configuration parameterConfig)
                 throws ConfigurationException

Parses a parameter from a XML configuration.

Parameters:

manager - the service manager.

pluginName - the plugin name declaring this parameter.

parameterConfig - the XML configuration.

Returns:

the parsed parameter.

Throws:

ConfigurationException - if the configuration is not valid.

lookupComponents

public void lookupComponents()
                      throws Exception

Retrieves local validators and enumerators components and set them into previous parameter parsed.

Throws:

Exception - if an error occurs.

_createParameter

protected abstract P _createParameter(Configuration parameterConfig)
                               throws ConfigurationException

Create the parameter to populate it.

Parameters:

parameterConfig - the parameter configuration to use.

Returns:

the parameter instantiated.

Throws:

ConfigurationException - if the configuration is not valid.

_parseId

protected abstract String _parseId(Configuration parameterConfig)
                            throws ConfigurationException

Parses the id.

Parameters:

parameterConfig - the parameter configuration to use.

Returns:

the id.

Throws:

ConfigurationException - if the configuration is not valid.

_parseI18nizableText

protected I18nizableText _parseI18nizableText(Configuration config,
                                              String pluginName,
                                              String name)
                                       throws ConfigurationException

Parses an i18n text.

Parameters:

config - the configuration to use.

pluginName - the current plugin name.

name - the child name.

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

_parseType

protected abstract T _parseType(Configuration parameterConfig)
                         throws ConfigurationException

Parses the type.

Parameters:

parameterConfig - the parameter configuration to use.

Returns:

the type.

Throws:

ConfigurationException - if the configuration is not valid.

_parseWidget

protected String _parseWidget(Configuration parameterConfig)
                       throws ConfigurationException

Parses the widget.

Parameters:

parameterConfig - the parameter configuration to use.

Returns:

the widget or null if none defined.

Throws:

ConfigurationException - if the configuration is not valid.

_parseWidgetParameters

protected Map<String,I18nizableText> _parseWidgetParameters(Configuration parameterConfig,
                                                            String pluginName)
                                                     throws ConfigurationException

Parses the widget's parameters

Parameters:

parameterConfig - the parameter configuration to use.

pluginName - the current plugin name.

Returns:

the widget's parameters in a Map

Throws:

ConfigurationException - if the configuration is not valid.

_parseAndSetEnumerator

protected void _parseAndSetEnumerator(String pluginName,
                                      P parameter,
                                      String parameterId,
                                      Configuration parameterConfig)
                               throws ConfigurationException

Parses the enumerator.

Parameters:

pluginName - the plugin name.

parameter - the parameter.

parameterId - the parameter id.

parameterConfig - the parameter configuration.

Throws:

ConfigurationException - if the configuration is not valid.

_parseAndSetValidator

protected void _parseAndSetValidator(String pluginName,
                                     P parameter,
                                     String parameterId,
                                     Configuration parameterConfig)
                              throws ConfigurationException

Parses the validator.

Parameters:

pluginName - the plugin name.

parameter - the parameter.

parameterId - the parameter id.

parameterConfig - the parameter configuration.

Throws:

ConfigurationException - if the configuration is not valid.

_parseDefaultValue

protected abstract Object _parseDefaultValue(Configuration parameterConfig,
                                             P parameter)
                                      throws ConfigurationException

Parses the default value.

Parameters:

parameterConfig - the parameter configuration.

parameter - the parameter.

Returns:

the default value or null if none defined.

Throws:

ConfigurationException - if the configuration is not valid.

_additionalParsing

protected void _additionalParsing(ServiceManager manager,
                                  String pluginName,
                                  Configuration parameterConfig,
                                  String parameterId,
                                  P parameter)
                           throws ConfigurationException

Called for additional parsing.
Default implementation does nothing.

Parameters:

manager - the sservice manager.

pluginName - the plugin name.

parameterConfig - the parameter configuration.

parameterId - the parameter id.

parameter - the parameter to populate.

Throws:

ConfigurationException - if the configuration is not valid.