org.exolab.castor.xml.validators

Class DateTimeValidator

java.lang.Object

org.exolab.castor.xml.validators.PatternValidator

org.exolab.castor.xml.validators.DateTimeValidator

All Implemented Interfaces:

TypeValidator

public class DateTimeValidator
extends PatternValidator
implements TypeValidator

The Date/Time Validation class. This class handles validation for all XML Schema date & time types.

Version:

$Revision: 6587 $ $Date: $

Field Summary

Fields inherited from class org.exolab.castor.xml.validators.PatternValidator

resourceBundle

Constructor Summary

Constructors

Constructor and Description
DateTimeValidator() No-arg constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearFixed() Clears the fixed value for this DateTimeValidator.
void	clearMax() Clears the maximum value for this DateTimeValidator.
void	clearMin() Clears the minimum value for this DateTimeValidator.
DateTimeBase	getFixed() Returns the configured fixed value for date/time validation.
DateTimeBase	getMaxExclusive() Returns the configured exclusive maximum value for date/time validation.
DateTimeBase	getMaxInclusive() Returns the configured inclusive maximum value for date/time validation.
DateTimeBase	getMinExclusive() Returns the configured exclusive minimum value for date/time validation.
DateTimeBase	getMinInclusive() Returns the configured inclusive minimum value for date/time validation.
boolean	hasFixed() Returns true if a fixed value to validate against has been set.
void	setFixed(DateTimeBase fixedValue) Sets the fixed value for date/time validation.
void	setMaxExclusive(DateTimeBase maxValue) Sets the maximum (exclusive) value for date/time validation.
void	setMaxInclusive(DateTimeBase maxValue) Sets the maximum (inclusive) value for date/time validation.
void	setMinExclusive(DateTimeBase minValue) Sets the minimum (exclusive) value for date/time validation.
void	setMinInclusive(DateTimeBase minValue) Sets the minimum (inclusive) value for date/time validation.
void	validate(DateTimeBase dateTime) Validates a Date/Time instance.
void	validate(DateTimeBase dateTime, ValidationContext context) Validates a Date/Time instance.
void	validate(Object object) Validates the given Object.
void	validate(Object object, ValidationContext context) Validates the given Object.

Methods inherited from class org.exolab.castor.xml.validators.PatternValidator

addPattern, clearPatterns, getPatterns, hasPattern, isNillable, setNillable, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeValidator

public DateTimeValidator()

No-arg constructor.

Method Detail

clearFixed

public void clearFixed()

Clears the fixed value for this DateTimeValidator.

clearMax

public void clearMax()

Clears the maximum value for this DateTimeValidator.

clearMin

public void clearMin()

Clears the minimum value for this DateTimeValidator.

getFixed

public DateTimeBase getFixed()

Returns the configured fixed value for date/time validation. Returns null if no fixed value has been configured.

Returns:

the fixed value to validate against.

getMaxInclusive

public DateTimeBase getMaxInclusive()

Returns the configured inclusive maximum value for date/time validation. Returns null if no inclusive maximum has been configured.

Returns:

the maximum (inclusive) value to validate against.

getMaxExclusive

public DateTimeBase getMaxExclusive()

Returns the configured exclusive maximum value for date/time validation. Returns null if no exclusive maximum has been configured.

Returns:

the maximum (exclusive) value to validate against.

getMinInclusive

public DateTimeBase getMinInclusive()

Returns the configured inclusive minimum value for date/time validation. Returns null if no inclusive minimum has been configured.

Returns:

the minimum inclusive value to validate against.

getMinExclusive

public DateTimeBase getMinExclusive()

Returns the configured exclusive minimum value for date/time validation. Returns null if no exclusive minimum has been configured.

Returns:

the minimum exclusive value to validate against.

hasFixed

public boolean hasFixed()

Returns true if a fixed value to validate against has been set.

Returns:

true if a fixed value has been set.

setFixed

public void setFixed(DateTimeBase fixedValue)

Sets the fixed value for date/time validation.

NOTE: If maximum and/or minimum values have been set and the fixed value is not within that max/min range, then no date/time will pass validation. This is as according to the XML Schema spec.

Parameters:

fixedValue - the fixed value that a date/time validated with this validator must be equal to.

setMinExclusive

public void setMinExclusive(DateTimeBase minValue)

Sets the minimum (exclusive) value for date/time validation. To pass validation, a date/time must be greater than this value.

Parameters:

minValue - the minimum (exclusive) value for date/time validation.

setMinInclusive

public void setMinInclusive(DateTimeBase minValue)

Sets the minimum (inclusive) value for date/time validation. To pass validation, a date/time must be greater than or equal to this value.

Parameters:

minValue - the minimum (inclusive) value for date/time validation.

setMaxExclusive

public void setMaxExclusive(DateTimeBase maxValue)

Sets the maximum (exclusive) value for date/time validation. To pass validation, a date/time must be less than this value.

Parameters:

maxValue - the maximum (exclusive) value for date/time validation.

setMaxInclusive

public void setMaxInclusive(DateTimeBase maxValue)

Sets the maximum (inclusive) value for date/time validation. To pass validation, a date/time must be less than or equal to this value.

Parameters:

maxValue - the maximum (inclusive) value for date/time validation.

validate

public void validate(DateTimeBase dateTime)
              throws ValidationException

Validates a Date/Time instance.

Parameters:

dateTime - the date/time type to validate

Throws:

ValidationException - if the DateTime fails validation

validate

public void validate(DateTimeBase dateTime,
            ValidationContext context)
              throws ValidationException

Validates a Date/Time instance.

Parameters:

dateTime - the date/time type to validate

context - the ValidationContext

Throws:

ValidationException - if the DateTime fails validation

validate

public void validate(Object object)
              throws ValidationException

Validates the given Object.

Parameters:

object - the Object to validate

Throws:

ValidationException - if the object fails validation

validate

public void validate(Object object,
            ValidationContext context)
              throws ValidationException

Validates the given Object.

Specified by:

validate in interface TypeValidator

Overrides:

validate in class PatternValidator

Parameters:

object - the Object to validate

context - the ValidationContext

Throws:

ValidationException - if the object fails validation