org.ametys.cms.contenttype.validation

Class AbstractIntervalValidator<T>

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.contenttype.validation.AbstractContentValidator

org.ametys.cms.contenttype.validation.AbstractIntervalValidator<T>

Type Parameters:

T - The type tested by the validator.

All Implemented Interfaces:

ContentValidator, Configurable, LogEnabled, Serviceable

Direct Known Subclasses:

AbstractNumberIntervalValidator, DateIntervalValidator

public abstract class AbstractIntervalValidator<T>
extends AbstractContentValidator
implements Serviceable, Configurable

Base ContentValidator validating the content by comparing one or more couples of values. For each couple of values, the identified max value should be greater than or equal to the identified min value.

Field Summary

Fields

Modifier and Type	Field and Description
private ContentHelper	_contentHelper
private boolean	_mandatory
private String	_maxMetadataPath
private String	_minMetadataPath

Constructor Summary

Constructors

Constructor and Description
AbstractIntervalValidator()

Method Summary

Modifier and Type	Method and Description
private void	_checkMetadataDefinition(MetadataDefinition minDefinition, MetadataDefinition maxDefinition)
private List<SimpleField<T>>	_getValues(Form form, String metadataPath, MetadataDefinition parentDefinition)
protected void	_validateInterval(Content content, Errors errors, MetadataDefinition minDefinition, MetadataDefinition maxDefinition, List<Object> minValues, List<Object> maxValues) Validate the interval values of a content
protected abstract void	addErrorEmpty(Errors errors, MetadataDefinition minDefinition, MetadataDefinition maxDefinition, I18nizableText emptyLabel) Add an error when the max or the min value is empty but the interval is mandatory
protected abstract void	addIntervalError(Errors errors, MetadataDefinition minDefinition, MetadataDefinition maxDefinition, T min, T max) Add an error when the max value is less than the min value
void	configure(Configuration configuration)
protected abstract String	configureMaxPath(Configuration configuration) Get the metadata max path from the configuration
protected abstract String	configureMinPath(Configuration configuration) Get the metadata min path from the configuration
protected abstract SimpleField<T>	getEmptyValue() Get a value holder containing an empty value array.
protected abstract SimpleField<T>	getValues(Form parentForm, String fieldName) Get the values of the field to validate from the form.
protected abstract boolean	isLessThan(T n1, T n2) Test if the first number is less than the second one.
protected abstract boolean	isSupportedType(MetadataType type) Test if the metadata type is one expected by the validator
void	service(ServiceManager manager)
void	validate(Content content, Errors errors) Validates a content.
void	validate(Content content, Form form, MetadataSet metadataSet, Errors errors) Validates a content with the edited form.

Methods inherited from class org.ametys.cms.contenttype.validation.AbstractContentValidator

getContentType, setContentType

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

_contentHelper

private ContentHelper _contentHelper

_minMetadataPath

private String _minMetadataPath

_maxMetadataPath

private String _maxMetadataPath

_mandatory

private boolean _mandatory

Constructor Detail

AbstractIntervalValidator

public AbstractIntervalValidator()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

validate

public void validate(Content content,
                     Errors errors)

Description copied from interface: ContentValidator

Validates a content.

Specified by:

validate in interface ContentValidator

Parameters:

content - the content to validate

errors - the structure to populate if the validation failed.

_validateInterval

protected void _validateInterval(Content content,
                                 Errors errors,
                                 MetadataDefinition minDefinition,
                                 MetadataDefinition maxDefinition,
                                 List<Object> minValues,
                                 List<Object> maxValues)

Validate the interval values of a content

Parameters:

content - The content

errors - The list of errors to fill

minDefinition - The definition for the min value

maxDefinition - The definition for the max value

minValues - The list of min values

maxValues - The list of max values

validate

public void validate(Content content,
                     Form form,
                     MetadataSet metadataSet,
                     Errors errors)

Description copied from interface: ContentValidator

Validates a content with the edited form.

Specified by:

validate in interface ContentValidator

Parameters:

content - the content to validate

form - the form to validate

metadataSet - the edited metadata set

errors - the structure to populate if the validation failed.

_checkMetadataDefinition

private void _checkMetadataDefinition(MetadataDefinition minDefinition,
                                      MetadataDefinition maxDefinition)

_getValues

private List<SimpleField<T>> _getValues(Form form,
                                        String metadataPath,
                                        MetadataDefinition parentDefinition)

configureMinPath

protected abstract String configureMinPath(Configuration configuration)
                                    throws ConfigurationException

Get the metadata min path from the configuration

Parameters:

configuration - The configuration

Returns:

The metadata min path

Throws:

ConfigurationException - If an error occurs

configureMaxPath

protected abstract String configureMaxPath(Configuration configuration)
                                    throws ConfigurationException

Get the metadata max path from the configuration

Parameters:

configuration - The configuration

Returns:

The metadata max path

Throws:

ConfigurationException - If an error occurs

getValues

protected abstract SimpleField<T> getValues(Form parentForm,
                                            String fieldName)

Get the values of the field to validate from the form.

Parameters:

parentForm - The form containing the user values.

fieldName - The field name.

Returns:

The values.

getEmptyValue

protected abstract SimpleField<T> getEmptyValue()

Get a value holder containing an empty value array.

Returns:

a value holder containing an empty value array.

isLessThan

protected abstract boolean isLessThan(T n1,
                                      T n2)

Test if the first number is less than the second one.

Parameters:

n1 - The first number to compare.

n2 - The second number to compare.

Returns:

true if the first number is less than the first, false otherwise.

isSupportedType

protected abstract boolean isSupportedType(MetadataType type)

Test if the metadata type is one expected by the validator

Parameters:

type - The metadata type

Returns:

True if the type is supported

addIntervalError

protected abstract void addIntervalError(Errors errors,
                                         MetadataDefinition minDefinition,
                                         MetadataDefinition maxDefinition,
                                         T min,
                                         T max)

Add an error when the max value is less than the min value

Parameters:

errors - The list of errors

minDefinition - The min definition

maxDefinition - The max definition

min - The min value

max - The max value

addErrorEmpty

protected abstract void addErrorEmpty(Errors errors,
                                      MetadataDefinition minDefinition,
                                      MetadataDefinition maxDefinition,
                                      I18nizableText emptyLabel)

Add an error when the max or the min value is empty but the interval is mandatory

Parameters:

errors - The list of errors

minDefinition - The min definition

maxDefinition - The max definition

emptyLabel - The label of the empty field