Package org.apache.fulcrum.intake.validator

Class StringValidator

java.lang.Object

org.apache.fulcrum.intake.validator.DefaultValidator<String>

org.apache.fulcrum.intake.validator.StringValidator

All Implemented Interfaces:

org.apache.avalon.framework.logger.LogEnabled, InitableByConstraintMap, Validator<String>

public class StringValidator
extends DefaultValidator<String>

A validator that will compare a testValue against the following constraints:

Validation rules

Name	Valid Values	Default Value
required	true|false	false
mask	regexp
minLength	integer	0
maxLength	integer

This validator can serve as the base class for more specific validators

Version:

$Id$

Author:

John McNally, Quinton McCombs, Colin Chalmers, Jürgen Hoffmann, Thomas Vandahl

Field Summary

Fields

Modifier and Type	Field	Description
protected String	maskMessage	The message to report if the mask constraint is not satisfied
protected Pattern	maskPattern	The compiled Regular Expression
protected String	maskString	The matching mask String as supplied by the XML input

Fields inherited from class org.apache.fulcrum.intake.validator.DefaultValidator

errorMessage, log, maxLength, maxLengthMessage, minLength, minLengthMessage, required, requiredMessage

Fields inherited from interface org.apache.fulcrum.intake.validator.Validator

FLEXIBLE_RULE_NAME, FORMAT_RULE_NAME, INVALID_NUMBER_RULE_NAME, MASK_RULE_NAME, MAX_LENGTH_RULE_NAME, MAX_VALUE_RULE_NAME, MIN_LENGTH_RULE_NAME, MIN_VALUE_RULE_NAME, REQUIRED_RULE_NAME

Constructor Summary

Constructors

Constructor	Description
StringValidator()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	assertValidity(String testValue)	Determine whether a testValue meets the criteria specified in the constraints defined for this validator
String	getMask()	Get the value of mask.
String	getMaskMessage()	Get the value of maskMessage.
void	init(Map<String,? extends Constraint> paramMap)	Extract the relevant parameters from the constraints listed in <rule> tags within the intake.xml file.
void	setMask(String mask)	Set the value of mask.
void	setMaskMessage(String message)	Set the value of maskMessage.

Methods inherited from class org.apache.fulcrum.intake.validator.DefaultValidator

assertValidity, enableLogging, getMaxLength, getMaxLengthMessage, getMessage, getMinLength, getMinLengthMessage, getRequiredMessage, isRequired, isValid, isValid, setMaxLength, setMaxLengthMessage, setMinLength, setMinLengthMessage, setRequired, setRequiredMessage

Methods inherited from class java.lang.Object

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

Field Detail

maskString

protected String maskString

The matching mask String as supplied by the XML input

maskPattern

protected Pattern maskPattern

The compiled Regular Expression

maskMessage

protected String maskMessage

The message to report if the mask constraint is not satisfied

Constructor Detail

StringValidator

public StringValidator()

Default constructor

Method Detail

init

public void init(Map<String,? extends Constraint> paramMap)
          throws InvalidMaskException

Extract the relevant parameters from the constraints listed in <rule> tags within the intake.xml file.

Specified by:

init in interface InitableByConstraintMap

Overrides:

init in class DefaultValidator<String>

Parameters:

paramMap - a Map of Rule's containing constraints on the input.

Throws:

InvalidMaskException - An invalid mask was specified for one of the rules

assertValidity

public void assertValidity(String testValue)
                    throws ValidationException

Determine whether a testValue meets the criteria specified in the constraints defined for this validator

Specified by:

assertValidity in interface Validator<String>

Overrides:

assertValidity in class DefaultValidator<String>

Parameters:

testValue - a String to be tested

Throws:

ValidationException - containing an error message if the testValue did not pass the validation tests.

getMask

public String getMask()

Get the value of mask.

Returns:

value of mask.

setMask

public void setMask(String mask)
             throws InvalidMaskException

Set the value of mask.

Parameters:

mask - Value to assign to mask.

Throws:

InvalidMaskException - the mask could not be compiled.

getMaskMessage

public String getMaskMessage()

Get the value of maskMessage.

Returns:

value of maskMessage.

setMaskMessage

public void setMaskMessage(String message)

Set the value of maskMessage.

Parameters:

message - Value to assign to maskMessage.