org.ametys.runtime.parameter

Class ParameterCheckerParser

java.lang.Object

org.ametys.runtime.parameter.ParameterCheckerParser

Direct Known Subclasses:

ConfigParameterCheckerParser

public class ParameterCheckerParser
extends Object

Parameter checker parser from an XML configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected ThreadSafeComponentManager<ParameterChecker>	_parameterCheckerManager The parameter checker component manager.
private Map<ParameterCheckerDescriptor,String>	_parameterCheckersToLookup
protected String	_pluginName The name of the plugin declaring this parameter checker

Constructor Summary

Constructors

Constructor and Description
ParameterCheckerParser(ThreadSafeComponentManager<ParameterChecker> paramCheckerManager) Create a parameter checker parser

Method Summary

Modifier and Type	Method and Description
protected ParameterCheckerDescriptor	_getParameterCheckerDescriptorInstance() Get the parameter checker descriptor instance to use
protected I18nizableText	_parseI18nizableText(Configuration config, String pluginName, String name) Parses an i18n text.
protected void	_setParameterChecker(String pluginName, ParameterCheckerDescriptor parameterChecker, String parameterCheckerId, Configuration parameterCheckerConfig) Sets the parameter checker.
void	lookupComponents() Retrieves local parameter checkers components and sets them into the previous parameter checker parsed.
ParameterCheckerDescriptor	parseParameterChecker(String pluginName, Configuration paramCheckerConfig) Parse a parameter checker from a XML configuration.

Methods inherited from class java.lang.Object

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

Field Detail

_parameterCheckerManager

protected ThreadSafeComponentManager<ParameterChecker> _parameterCheckerManager

The parameter checker component manager.

_pluginName

protected String _pluginName

The name of the plugin declaring this parameter checker

_parameterCheckersToLookup

private final Map<ParameterCheckerDescriptor,String> _parameterCheckersToLookup

Constructor Detail

ParameterCheckerParser

public ParameterCheckerParser(ThreadSafeComponentManager<ParameterChecker> paramCheckerManager)

Create a parameter checker parser

Parameters:

paramCheckerManager - the parameter checker.

Method Detail

parseParameterChecker

public ParameterCheckerDescriptor parseParameterChecker(String pluginName,
                                                        Configuration paramCheckerConfig)
                                                 throws ConfigurationException

Parse a parameter checker from a XML configuration.

Parameters:

pluginName - the plugin's name declaring this parameter.

paramCheckerConfig - the XML configuration.

Returns:

the ParameterCheckerDescriptor for the parsed parameter checker

Throws:

ConfigurationException - if the configuration is not valid.

_setParameterChecker

protected void _setParameterChecker(String pluginName,
                                    ParameterCheckerDescriptor parameterChecker,
                                    String parameterCheckerId,
                                    Configuration parameterCheckerConfig)
                             throws ConfigurationException

Sets the parameter checker.

Parameters:

pluginName - the plugin's name.

parameterChecker - the parameter checker.

parameterCheckerId - the parameter chekcer's id.

parameterCheckerConfig - the parameter checker's configuration.

Throws:

ConfigurationException - if the configuration is not valid.

lookupComponents

public void lookupComponents()
                      throws Exception

Retrieves local parameter checkers components and sets them into the previous parameter checker parsed.

Throws:

Exception - if an error occurs.

_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.

_getParameterCheckerDescriptorInstance

protected ParameterCheckerDescriptor _getParameterCheckerDescriptorInstance()

Get the parameter checker descriptor instance to use

Returns:

the parameter checker descriptor instance to use