org.ametys.runtime.parameter

Class DefaultValidator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.runtime.parameter.DefaultValidator

All Implemented Interfaces:

Validator, PluginAware, Configurable, LogEnabled, Serviceable

Direct Known Subclasses:

RegexpValidator, SQLDatabaseTypeValidator, TextValidator

public class DefaultValidator
extends AbstractLogEnabled
implements Validator, Configurable, PluginAware, Serviceable

This default implementation validates the following configurable stuff:

• mandatory: check the parameter is set
• regexp: check the string parameter matches a regexp

Field Summary

Fields

Modifier and Type	Field and Description
protected I18nizableText	_invalidText The error text to display if regexp fails
protected boolean	_isMandatory Is the value mandatory ?
private JSONUtils	_jsonUtils
protected String	_pluginName The plugin name
protected Pattern	_regexp Does the value need to match a regexp
protected ServiceManager	_smanager The service manager

Constructor Summary

Constructors

Constructor and Description
DefaultValidator() Default constructor for avalon
DefaultValidator(String regexp, boolean mandatory) Manual constructor
DefaultValidator(String regexp, I18nizableText invalidText, boolean mandatory) Manual constructor

Method Summary

Modifier and Type	Method and Description
private boolean	_matchRegexp(Object[] values)
void	configure(Configuration configuration)
Map<String,Object>	getConfiguration() Retrieves the configuration of the validator.
void	saxConfiguration(ContentHandler handler) Sax the configuration of the validator to allow the client side to prevalidate
protected void	saxJsonConfig(ContentHandler handler) SAX the JSON configuration of this validator
void	service(ServiceManager smanager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
Map<String,Object>	toJson() Returns a object representing the validator able to be converted into a JSON string
void	validate(Object value, Errors errors) Validates a value.
protected void	validateArrayValues(Object[] values, Errors errors) Validates a array of values.
protected void	validateSingleValue(Object value, Errors errors) Validates a single value.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_isMandatory

protected boolean _isMandatory

Is the value mandatory ?

_regexp

protected Pattern _regexp

Does the value need to match a regexp

_invalidText

protected I18nizableText _invalidText

The error text to display if regexp fails

_pluginName

protected String _pluginName

The plugin name

_smanager

protected ServiceManager _smanager

The service manager

_jsonUtils

private JSONUtils _jsonUtils

Constructor Detail

DefaultValidator

public DefaultValidator()

Default constructor for avalon

DefaultValidator

public DefaultValidator(String regexp,
                        boolean mandatory)

Manual constructor

Parameters:

regexp - The regexp to check or null

mandatory - Is the value mandatory

DefaultValidator

public DefaultValidator(String regexp,
                        I18nizableText invalidText,
                        boolean mandatory)

Manual constructor

Parameters:

regexp - The regexp to check or null

invalidText - The error text to display

mandatory - Is the value mandatory

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

toJson

public Map<String,Object> toJson()

Description copied from interface: Validator

Returns a object representing the validator able to be converted into a JSON string

Specified by:

toJson in interface Validator

Returns:

the JSON object

saxJsonConfig

protected void saxJsonConfig(ContentHandler handler)
                      throws SAXException

SAX the JSON configuration of this validator

Parameters:

handler - The content handlet to sax into

Throws:

SAXException - if an error occurred

saxConfiguration

public void saxConfiguration(ContentHandler handler)
                      throws SAXException

Description copied from interface: Validator

Sax the configuration of the validator to allow the client side to prevalidate

Specified by:

saxConfiguration in interface Validator

Parameters:

handler - The content handler where to sax parameters

Throws:

SAXException - if an error occured

getConfiguration

public Map<String,Object> getConfiguration()

Description copied from interface: Validator

Retrieves the configuration of the validator. Information contained in the returned map should be the same than those SAX'ed in Validator.saxConfiguration(ContentHandler)

Specified by:

getConfiguration in interface Validator

Returns:

a map containing the configuration information.

validate

public void validate(Object value,
                     Errors errors)

Description copied from interface: Validator

Validates a value.

Specified by:

validate in interface Validator

Parameters:

value - the value to validate (can be null).

errors - the structure to populate if the validation failed.

validateSingleValue

protected void validateSingleValue(Object value,
                                   Errors errors)

Validates a single value.

Parameters:

value - the value to validate (can be null).

errors - the structure to populate if the validation failed.

validateArrayValues

protected void validateArrayValues(Object[] values,
                                   Errors errors)

Validates a array of values.

Parameters:

values - the values to validate

errors - the structure to populate if the validation failed.

_matchRegexp

private boolean _matchRegexp(Object[] values)