org.exolab.castor.xml.validators

Class DecimalValidator

java.lang.Object

org.exolab.castor.xml.validators.PatternValidator

org.exolab.castor.xml.validators.DecimalValidator

All Implemented Interfaces:

TypeValidator

public class DecimalValidator
extends PatternValidator
implements TypeValidator

The Decimal Validation class. This class handles validation for the Decimal type. TODO : pattern, enumeration

Version:

$Revision: 6383 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Arnaud Blandin

Nested Class Summary

Nested classes/interfaces inherited from class org.exolab.castor.xml.validators.PatternValidator

PatternValidator.DefaultRegExpEvaluator

Constructor Summary

Constructors

Constructor and Description
DecimalValidator() Creates a new DecimalValidator with no restrictions

Method Summary

Modifier and Type	Method and Description
void	clearMax() Clears the maximum value for this DecimalValidator
void	clearMin() Clears the minimum value for this DecimalValidator
java.math.BigDecimal	getFixed() Returns the fixed value that decimals validated with this validator must be equal to.
java.math.BigDecimal	getMaxInclusive() Returns the maximum value that decimals validated with this validator must be equal to or less than.
java.math.BigDecimal	getMinInclusive() Returns the minimum value that decimals validated with this validator must be equal to or greater than.
boolean	hasFixed() Returns true if a fixed value, to validate against, has been set.
void	setFixed(java.math.BigDecimal fixed) Sets the fixed value the decimal to validate must be equal to.
void	setFractionDigits(int fractionDig) Sets the fractionDigits facet for this decimal validator.
void	setMaxExclusive(java.math.BigDecimal maxValue) Sets the maximum value that decimals validated with this validator must be less than
void	setMaxInclusive(java.math.BigDecimal maxValue) Sets the maximum value that decimals validated with this validator are allowed to be
void	setMinExclusive(java.math.BigDecimal minValue) Sets the minimum value that decimals validated with this validator must be greater than
void	setMinInclusive(java.math.BigDecimal minValue) Sets the minimum value that decimals validated with this validator are allowed to be
void	setTotalDigits(int totalDig) Sets the totalDigits facet for this decimal validator.
void	validate(java.math.BigDecimal bd, ValidationContext context)
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

getPattern, 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

DecimalValidator

public DecimalValidator()

Creates a new DecimalValidator with no restrictions

Method Detail

clearMax

public void clearMax()

Clears the maximum value for this DecimalValidator

clearMin

public void clearMin()

Clears the minimum value for this DecimalValidator

getFixed

public java.math.BigDecimal getFixed()

Returns the fixed value that decimals validated with this validator must be equal to. A null value is returned if no fixed value has been specified.

Returns:

the fixed value to validate against.

getMaxInclusive

public java.math.BigDecimal getMaxInclusive()

Returns the maximum value that decimals validated with this validator must be equal to or less than. A null value is returned if no maximum value has been specified.

Returns:

the maximum inclusive value to validate against.

getMinInclusive

public java.math.BigDecimal getMinInclusive()

Returns the minimum value that decimals validated with this validator must be equal to or greater than. A null value is returned if no minimum value has been specified.

Returns:

the minimum inclusive 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.

setMinExclusive

public void setMinExclusive(java.math.BigDecimal minValue)

Sets the minimum value that decimals validated with this validator must be greater than

Parameters:

minValue - the minimum value an decimal validated with this validator must be greater than

setMinInclusive

public void setMinInclusive(java.math.BigDecimal minValue)

Sets the minimum value that decimals validated with this validator are allowed to be

Parameters:

minValue - the minimum value an decimal validated with this validator may be

setMaxExclusive

public void setMaxExclusive(java.math.BigDecimal maxValue)

Sets the maximum value that decimals validated with this validator must be less than

Parameters:

maxValue - the maximum value an decimal validated with this validator must be less than

setMaxInclusive

public void setMaxInclusive(java.math.BigDecimal maxValue)

Sets the maximum value that decimals validated with this validator are allowed to be

Parameters:

maxValue - the maximum value an decimal validated with this validator may be

setTotalDigits

public void setTotalDigits(int totalDig)

Sets the totalDigits facet for this decimal validator.

Parameters:

totalDig - the value of totalDigits (must be >0)

setFractionDigits

public void setFractionDigits(int fractionDig)

Sets the fractionDigits facet for this decimal validator.

Parameters:

fractionDig - the value of fractionDigits (must be >=0)

setFixed

public void setFixed(java.math.BigDecimal fixed)

Sets the fixed value the decimal to validate must be equal to.

Parameters:

fixed - the fixed value

validate

public void validate(java.math.BigDecimal bd,
                     ValidationContext context)
              throws ValidationException

Throws:

ValidationException

validate

public void validate(java.lang.Object object)
              throws ValidationException

Validates the given Object

Parameters:

object - the Object to validate

Throws:

ValidationException

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