Package 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:

AbstractIntervalFormValidator, CandidatesValidator, FileFormValidator, FileValidator, NameForFormValidator, ReferenceValidator, 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	Description
protected I18nizableText	_invalidText	The error text to display if regexp fails
protected boolean	_isMandatory	Is the value mandatory ?
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	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	Description
void	configure(Configuration configuration)
boolean	equals(Object obj)
Map<String,Object>	getConfiguration()	Retrieves the configuration of the validator.
int	hashCode()
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.
ValidationResult	validate(Object value)	Validates a value.
protected ValidationResult	validateArrayValues(Object[] values)	Validates a array of values.
protected ValidationResult	validateSingleValue(Object value)	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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

_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

Constructor Details

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 Details

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

getConfiguration

public Map<String,Object> getConfiguration()

Description copied from interface: Validator

Retrieves the configuration of the validator.

Specified by:

getConfiguration in interface Validator

Returns:

a map containing the configuration information.

validate

public ValidationResult validate(Object value)

Description copied from interface: Validator

Validates a value.

Specified by:

validate in interface Validator

Parameters:

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

Returns:

the validation result

validateSingleValue

protected ValidationResult validateSingleValue(Object value)

Validates a single value.

Parameters:

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

Returns:

the validation result

validateArrayValues

protected ValidationResult validateArrayValues(Object[] values)

Validates a array of values.

Parameters:

values - the values to validate

Returns:

the validation result

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object