org.exolab.castor.xml
Class FieldValidator

java.lang.Object
  org.exolab.castor.xml.Validator
      org.exolab.castor.xml.FieldValidator

All Implemented Interfaces:

ClassValidator, TypeValidator

public class FieldValidator

extends Validator

Handles field validation

Version:

$Revision: 1.5 $ $Date: 2003/11/18 21:27:51 $

Author:

Keith Visco

Constructor Summary

FieldValidator()
Creates a default FieldValidator

FieldValidator(TypeValidator validator)
Creates a new FieldValidator using the given TypeValidator

Method Summary

int	getMaxOccurs() Returns the maximum number of occurances for a given object.
int	getMinOccurs() Returns the mimimum number of occurances for a given object.
TypeValidator	getTypeValidator() Returns true if a TypeValidator has been set
boolean	hasTypeValidator() Returns true if a TypeValidator has been set
void	setDescriptor(XMLFieldDescriptor descriptor) Sets the field descriptor to use for obtaining information about the field to validate, such as the field name, the field handler, etc.
void	setMaxOccurs(int maxOccurs) Sets the maximum number of occurances for a given object
void	setMinOccurs(int minOccurs) Sets the mimimum number of occurances for a given object
void	setValidator(TypeValidator validator)
void	validate(java.lang.Object object, ValidationContext context) Validates the given Object

Methods inherited from class org.exolab.castor.xml.Validator

validate

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldValidator

public FieldValidator()

Creates a default FieldValidator

FieldValidator

public FieldValidator(TypeValidator validator)

Creates a new FieldValidator using the given TypeValidator

Parameters:

validator - the TypeValidator to delegate validation to

Method Detail

getMinOccurs

public int getMinOccurs()

Returns the mimimum number of occurances for a given object.

getMaxOccurs

public int getMaxOccurs()

Returns the maximum number of occurances for a given object.

getTypeValidator

public TypeValidator getTypeValidator()

Returns true if a TypeValidator has been set

Returns:

true if a TypeValidator has been set

hasTypeValidator

public boolean hasTypeValidator()

Returns true if a TypeValidator has been set

Returns:

true if a TypeValidator has been set

setMinOccurs

public void setMinOccurs(int minOccurs)

Sets the mimimum number of occurances for a given object

Parameters:

minOccurs - the minimum number of times an object must occur in order to be valid. A zero, or negative value denotes no lower bound (ie. the object is optional)

setMaxOccurs

public void setMaxOccurs(int maxOccurs)

Sets the maximum number of occurances for a given object

Parameters:

maxOccurs - the maximum number of times an object may occur. A negative value denotes no upper bound.

setDescriptor

public void setDescriptor(XMLFieldDescriptor descriptor)

Sets the field descriptor to use for obtaining information about the field to validate, such as the field name, the field handler, etc.

Parameters:

descriptor - the field descriptor for the field to validate

setValidator

public void setValidator(TypeValidator validator)

validate

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

Validates the given Object

Specified by:

validate in interface ClassValidator

Overrides:

validate in class Validator

Parameters:

object - the Object that contains the field to validate

context - the ValidationContext

Throws:

ValidationException