org.apache.struts.validator

Class DynaValidatorForm

Implemented Interfaces:
DynaBean, Serializable
Known Direct Subclasses:
DynaValidatorActionForm

public class DynaValidatorForm
extends DynaActionForm
implements DynaBean, Serializable

This class extends DynaActionForm 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.
Version:
$Rev: 164862 $ $Date: 2005-04-26 20:08:32 +0100 (Tue, 26 Apr 2005) $
Since:
Struts 1.1
See Also:
ActionForm

Field Summary

private static Log
log
Commons Logging instance.
protected int
page
Used to indicate the current page of a multi-page form.
protected ValidatorResults
validatorResults
The results returned from the validation performed by the Validator.

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

dynaClass, dynaValues

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

multipartRequestHandler, servlet

Method Summary

int
getPage()
Gets page.
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.
String
getValidationKey(ActionMapping mapping, HttpServletRequest request)
Returns the Validation key.
ValidatorResults
getValidatorResults()
Get results of the validation performed by the Validator.
void
reset(ActionMapping mapping, HttpServletRequest request)
Reset all properties to their default values.
void
setPage(int page)
Sets page.
protected void
setPageFromDynaProperty()
Sets this.page to the value of the Dyna property "page" if it's defined.
void
setValidatorResults(ValidatorResults validatorResults)
Set results of the validation performed by the Validator.
ActionErrors
validate(ActionMapping mapping, 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.DynaActionForm

contains, get, get, get, getDynaClass, getDynaProperty, getMap, getString, getStrings, initialize, initialize, isDynaAssignable, remove, reset, reset, set, set, set, setDynaActionFormClass, toString

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

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

Field Details

log

private static Log log
Commons Logging instance.

page

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

validatorResults

protected ValidatorResults validatorResults
The results returned from the validation performed by the Validator.

Method Details

getPage

public int getPage()
Gets page.
Returns:
page number.

getResultValueMap

public 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:
Returns a Map of values, otherwise returns null if no results.

getValidationKey

public String getValidationKey(ActionMapping mapping,
                               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

getValidatorResults

public ValidatorResults getValidatorResults()
Get results of the validation performed by the Validator.
Returns:
validator results as ValidatorResults object

reset

public void reset(ActionMapping mapping,
                  HttpServletRequest request)
Reset all properties to their default values.
Overrides:
reset in interface DynaActionForm
Parameters:
mapping - The mapping used to select this instance
request - The servlet request we are processing

setPage

public void setPage(int page)
Sets page.
Parameters:
page - page number

setPageFromDynaProperty

protected void setPageFromDynaProperty()
Sets this.page to the value of the Dyna property "page" if it's defined. This is used to setup the page variable before validation starts.
Since:
Struts 1.2

setValidatorResults

public void setValidatorResults(ValidatorResults validatorResults)
Set results of the validation performed by the Validator.
Parameters:
validatorResults - Set results of the validation performed

validate

public ActionErrors validate(ActionMapping mapping,
                             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 interface 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.

Copyright B) 2000-2007 - The Apache Software Foundation