org.exolab.castor.xml.validators
Class DurationValidator

java.lang.Object
  extended by org.exolab.castor.xml.validators.PatternValidator
      extended by org.exolab.castor.xml.validators.DurationValidator
All Implemented Interfaces:
TypeValidator

public class DurationValidator
extends PatternValidator
implements TypeValidator

The Duration Validation class. This class handles validation for the Castor XML Schema duration type.

Version:
$Revision: 6587 $ $Date: 2003-03-03 02:57:21 -0700 (Mon, 03 Mar 2003) $
Author:
Keith Visco, Arnaud Blandin

Nested Class Summary
 
Nested classes/interfaces inherited from class org.exolab.castor.xml.validators.PatternValidator
PatternValidator.DefaultRegExpEvaluator
 
Constructor Summary
DurationValidator()
          No-arg constructor.
 
Method Summary
 void clearFixed()
          Clears the fixed value for this Duration.
 void clearMax()
          Clears the maximum value for this Duration.
 void clearMin()
          Clears the minimum value for this Duration.
 Duration getFixed()
          Returns the configured fixed value for Duration validation.
 Duration getMaxExclusive()
          Returns the configured exclusive maximum value for Duration validation.
 Duration getMaxInclusive()
          Returns the configured inclusive maximum value for Duration validation.
 Duration getMinExclusive()
          Returns the configured exclusive minimum value for Duration validation.
 Duration getMinInclusive()
          Returns the configured inclusive minimum value for Duration validation.
 boolean hasFixed()
          Returns true if a fixed value to validate against has been set.
 void setFixed(Duration fixedValue)
          Sets the fixed value for Duration validation.
 void setMaxExclusive(Duration maxValue)
          Sets the maximum (exclusive) value for Duration validation.
 void setMaxInclusive(Duration maxValue)
          Sets the maximum (inclusive) value for Duration validation.
 void setMinExclusive(Duration minValue)
          Sets the minimum (exclusive) value for Duration validation.
 void setMinInclusive(Duration minValue)
          Sets the minimum (inclusive) value for Duration validation.
 void validate(Duration duration)
          Validate a duration instance.
 void validate(Duration duration, ValidationContext context)
          Validates a duration instance.
 void validate(java.lang.Object object)
          Validates the given Object.
 void validate(java.lang.Object object, ValidationContext context)
          Validates the given Object.
 
Methods inherited from class org.exolab.castor.xml.validators.PatternValidator
addPattern, clearPatterns, getPattern, getPatterns, hasPattern, isNillable, setNillable, setPattern, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DurationValidator

public DurationValidator()
No-arg constructor.

Method Detail

clearFixed

public void clearFixed()
Clears the fixed value for this Duration.


clearMax

public void clearMax()
Clears the maximum value for this Duration.


clearMin

public void clearMin()
Clears the minimum value for this Duration.


getFixed

public Duration getFixed()
Returns the configured fixed value for Duration validation. Returns null if no fixed value has been configured.

Returns:
the fixed value to validate against.

getMaxInclusive

public Duration getMaxInclusive()
Returns the configured inclusive maximum value for Duration validation. Returns null if no inclusive maximum has been configured.

Returns:
the inclusive maximum value to validate against.

getMaxExclusive

public Duration getMaxExclusive()
Returns the configured exclusive maximum value for Duration validation. Returns null if no exclusive maximum has been configured.

Returns:
the exclusive maximum value to validate against.

getMinInclusive

public Duration getMinInclusive()
Returns the configured inclusive minimum value for Duration validation. Returns null if no inclusive minimum has been configured.

Returns:
the inclusive minimum value to validate against.

getMinExclusive

public Duration getMinExclusive()
Returns the configured exclusive minimum value for Duration validation. Returns null if no exclusive minimum has been configured.

Returns:
the exclusive minimum 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(Duration fixedValue)
Sets the fixed value for Duration validation.

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

Parameters:
fixedValue - the fixed value that a Duration validated with this validator must be equal to.

setMinExclusive

public void setMinExclusive(Duration minValue)
Sets the minimum (exclusive) value for Duration validation. To pass validation, a Duration must be greater than this value.

Parameters:
minValue - the minimum (exclusive) value for Duration validation.

setMinInclusive

public void setMinInclusive(Duration minValue)
Sets the minimum (inclusive) value for Duration validation. To pass validation, a Duration must be greater than or equal to this value.

Parameters:
minValue - the minimum (inclusive) value for Duration validation.

setMaxExclusive

public void setMaxExclusive(Duration maxValue)
Sets the maximum (exclusive) value for Duration validation. To pass validation, a Duration must be less than this value.

Parameters:
maxValue - the maximum (exclusive) value for Duration validation.

setMaxInclusive

public void setMaxInclusive(Duration maxValue)
Sets the maximum (inclusive) value for Duration validation. To pass validation, a Duration must be less than or equal to this value.

Parameters:
maxValue - the maximum (inclusive) value for Duration validation.

validate

public void validate(Duration duration)
              throws ValidationException
Validate a duration instance.

Parameters:
duration - the duration to validate
Throws:
ValidationException - if the duration fails validation

validate

public void validate(Duration duration,
                     ValidationContext context)
              throws ValidationException
Validates a duration instance.

Parameters:
duration - the duration type to validate
context - the ValidationContext
Throws:
ValidationException - if the duration fails validation

validate

public void validate(java.lang.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(java.lang.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


Intalio Inc. (C) 1999-2007. All rights reserved http://www.intalio.com