Package org.ametys.cms.contenttype.validation

Class DateTimeIntervalValidator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.contenttype.validation.AbstractContentValidator

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

org.ametys.cms.contenttype.validation.DateTimeIntervalValidator

All Implemented Interfaces:

ContentValidator, Configurable, LogEnabled

public class DateTimeIntervalValidator
extends AbstractIntervalValidator<ZonedDateTime>

This implementation of ContentValidator validates the content by comparing one or more couple of date values. For each couple of values, the identified end date should be greater than or equal to the identified start date. The start and end dates to compare are identified in validator's configuration by the attribute path as follows: <startDate path="path/to/attribute/start"/> <endDate path="path/to/attribute/end"/> If the path of metadata can contain one or more repeaters.

Constructor Summary

Constructors

Constructor	Description
DateTimeIntervalValidator()

Method Summary

Modifier and Type	Method	Description
protected void	addErrorEmpty(Errors errors, ElementDefinition minDefinition, ElementDefinition maxDefinition, I18nizableText emptyLabel)	Add an error when the max or the min value is empty but the interval is mandatory
protected void	addIntervalError(Errors errors, ElementDefinition minDefinition, ElementDefinition maxDefinition, ZonedDateTime startDate, ZonedDateTime endDate)	Add an error when the max value is less than the min value
protected String	configureMaxPath(Configuration configuration)	Get the metadata max path from the configuration
protected String	configureMinPath(Configuration configuration)	Get the metadata min path from the configuration
protected boolean	isLessThan(ZonedDateTime date1, ZonedDateTime date2)	Test if the first number is less than the second one.
protected boolean	isSupportedType(ElementType type)	Test if the attribute type is one expected by the validator

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

_validateInterval, configure, validate, validate

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

Constructor Details

DateTimeIntervalValidator

public DateTimeIntervalValidator()

Method Details

configureMinPath

protected String configureMinPath(Configuration configuration)
                           throws ConfigurationException

Description copied from class: AbstractIntervalValidator

Get the metadata min path from the configuration

Specified by:

configureMinPath in class AbstractIntervalValidator<ZonedDateTime>

Parameters:

configuration - The configuration

Returns:

The metadata min path

Throws:

ConfigurationException - If an error occurs

configureMaxPath

protected String configureMaxPath(Configuration configuration)
                           throws ConfigurationException

Description copied from class: AbstractIntervalValidator

Get the metadata max path from the configuration

Specified by:

configureMaxPath in class AbstractIntervalValidator<ZonedDateTime>

Parameters:

configuration - The configuration

Returns:

The metadata max path

Throws:

ConfigurationException - If an error occurs

isLessThan

protected boolean isLessThan(ZonedDateTime date1,
 ZonedDateTime date2)

Description copied from class: AbstractIntervalValidator

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

Specified by:

isLessThan in class AbstractIntervalValidator<ZonedDateTime>

Parameters:

date1 - The first number to compare.

date2 - The second number to compare.

Returns:

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

isSupportedType

protected boolean isSupportedType(ElementType type)

Description copied from class: AbstractIntervalValidator

Test if the attribute type is one expected by the validator

Specified by:

isSupportedType in class AbstractIntervalValidator<ZonedDateTime>

Parameters:

type - The attribute type

Returns:

True if the type is supported

addIntervalError

protected void addIntervalError(Errors errors,
 ElementDefinition minDefinition,
 ElementDefinition maxDefinition,
 ZonedDateTime startDate,
 ZonedDateTime endDate)

Description copied from class: AbstractIntervalValidator

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

Specified by:

addIntervalError in class AbstractIntervalValidator<ZonedDateTime>

Parameters:

errors - The list of errors

minDefinition - The min definition

maxDefinition - The max definition

startDate - The min value

endDate - The max value

addErrorEmpty

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

Description copied from class: AbstractIntervalValidator

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

Specified by:

addErrorEmpty in class AbstractIntervalValidator<ZonedDateTime>

Parameters:

errors - The list of errors

minDefinition - The min definition

maxDefinition - The max definition

emptyLabel - The label of the empty field