org.apache.struts.validator

Class ValidatorForm

Implemented Interfaces:
Serializable
Known Direct Subclasses:
ValidatorActionForm

public class ValidatorForm
extends ActionForm
implements 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.

Version:
$Revision: 1.9 $ $Date: 2003/05/01 17:47:55 $

Author:
David Winterfeldt

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.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.
ValidatorResults
getValidatorResults()
Get results of the validation performed by the Validator.
protected void
log(String message)
Deprecated. Use common-logging to log debug messages.
protected void
log(String message, Throwable throwable)
Deprecated. Use common-logging to log debug messages.
void
reset(ActionMapping mapping, HttpServletRequest request)
Reset all properties to their default values.
void
setPage(int page)
Sets page.
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.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:
Map of non-null values


getValidatorResults

public ValidatorResults getValidatorResults()
Get results of the validation performed by the Validator.

Returns:
results of the validation


log

protected void log(String message)

Deprecated. Use common-logging to log debug messages.

Convenience method that call the comparable servlet log method and writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.

Parameters:
message - String that describes the error or exception


log

protected void log(String message,
                   Throwable throwable)

Deprecated. Use common-logging to log debug messages.

Convenience method that call the comparable servlet log method and writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.

Parameters:
message - String that describes the error or exception
throwable - Throwable error or exception


reset

public void reset(ActionMapping mapping,
                  HttpServletRequest request)
Reset all properties to their default values.
Overrides:
reset in interface ActionForm

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


setValidatorResults

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

Parameters:
validatorResults - results of validation


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-2005 - Apache Software Foundation