org.apache.struts.validator

Class ValidatorForm

java.lang.Object

org.apache.struts.action.ActionForm

org.apache.struts.validator.ValidatorForm

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BeanValidatorForm, ValidatorActionForm

public class ValidatorForm
extends ActionForm
implements java.io.Serializable

This class extends ActionForm and provides basic field validation based on an XML file. The key passed into the validator is the action element's 'name' attribute from the struts-config.xml which should match the form element's name attribute in the validation.xml.

• See ValidatorPlugin definition in struts-config.xml for validation rules.

Since:

Struts 1.1

Version:

$Rev: 471754 $ $Date: 2005-05-07 12:11:38 -0400 (Sat, 07 May 2005) $

See Also:

ActionForm, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	page Used to indicate the current page of a multi-page form.
protected org.apache.commons.validator.ValidatorResults	validatorResults The results returned from the validation performed by the Validator.

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
ValidatorForm()

Method Summary

Modifier and Type	Method and Description
protected int	determinePage(ActionMapping mapping, javax.servlet.http.HttpServletRequest request) Determine validation page. If acceptPage of ActionMapping is null, then returns Integer.MAX_VALUE.
int	getPage() Gets page.
java.util.Map	getResultValueMap() Returns a Map of values returned from any validation that returns a value other than null or Boolean with the key the full property path of the field.
java.lang.String	getValidationKey(ActionMapping mapping, javax.servlet.http.HttpServletRequest request) Returns the Validation key.
org.apache.commons.validator.ValidatorResults	getValidatorResults() Get results of the validation performed by the Validator.
void	reset(ActionMapping mapping, javax.servlet.http.HttpServletRequest request) Reset all properties to their default values.
void	setPage(int page) Sets page.
void	setValidatorResults(org.apache.commons.validator.ValidatorResults validatorResults) Set results of the validation performed by the Validator.
ActionErrors	validate(ActionMapping mapping, javax.servlet.http.HttpServletRequest request) Validate the properties that have been set from this HTTP request, and return an ActionErrors object that encapsulates any validation errors that have been found.

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Field Detail

validatorResults

protected org.apache.commons.validator.ValidatorResults validatorResults

The results returned from the validation performed by the Validator.

page

protected int page

Used to indicate the current page of a multi-page form.

Constructor Detail

ValidatorForm

public ValidatorForm()

Method Detail

getPage

public int getPage()

Gets page.

Returns:

page number

setPage

public void setPage(int page)

Sets page.

Parameters:

page - page number

validate

public ActionErrors validate(ActionMapping mapping,
                             javax.servlet.http.HttpServletRequest request)

Validate the properties that have been set from this HTTP request, and return an ActionErrors object that encapsulates any validation errors that have been found. If no errors are found, return null or an ActionErrors object with no recorded error messages.

Overrides:

validate in class ActionForm

Parameters:

mapping - The mapping used to select this instance

request - The servlet request we are processing

Returns:

ActionErrors object that encapsulates any validation errors

See Also:

DynaActionForm

determinePage

protected int determinePage(ActionMapping mapping,
                            javax.servlet.http.HttpServletRequest request)

Determine validation page.
If acceptPage of ActionMapping is null, then returns Integer.MAX_VALUE. (multi-page validation is disabled. All validation fields are enabled.)
If page property is less than acceptPage of ActionMapping, returns acceptPage value.
If page property is greater than or equal to acceptPage of ActionMapping, returns page property value.

Parameters:

mapping - The mapping used to select this instance.

request - The servlet request we are processing.

Returns:

validation page.

Since:

Struts 1.2.9-sp2

getValidationKey

public java.lang.String getValidationKey(ActionMapping mapping,
                                         javax.servlet.http.HttpServletRequest request)

Returns the Validation key.

Parameters:

mapping - The mapping used to select this instance

request - The servlet request we are processing

Returns:

validation key - the form element's name in this case

reset

public void reset(ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)

Reset all properties to their default values.

Overrides:

reset in class ActionForm

Parameters:

mapping - The mapping used to select this instance

request - The servlet request we are processing

getValidatorResults

public org.apache.commons.validator.ValidatorResults getValidatorResults()

Get results of the validation performed by the Validator.

Returns:

results of the validation

setValidatorResults

public void setValidatorResults(org.apache.commons.validator.ValidatorResults validatorResults)

Set results of the validation performed by the Validator.

Parameters:

validatorResults - results of validation

getResultValueMap

public java.util.Map getResultValueMap()

Returns a Map of values returned from any validation that returns a value other than null or Boolean with the key the full property path of the field.

Returns:

Map of non-null values