Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> struts >> [ validator overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

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 org.apache.struts.action.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: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

---

Field Summary
private static org.apache.commons.logging.Log	log           Commons Logging instance.
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

ValidatorForm()

 

Method Summary
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(org.apache.struts.action.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(org.apache.struts.action.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.
org.apache.struts.action.ActionErrors	validate(org.apache.struts.action.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

log

private static org.apache.commons.logging.Log log

Commons Logging instance.

---

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.

---

setPage

public void setPage(int page)

Sets page.

---

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.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.

---

getValidationKey

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

Returns the Validation key.

---

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)

Reset all properties to their default values.

---

getValidatorResults

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

Get results of the validation performed by the Validator.

---

setValidatorResults

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

Set results of the validation performed by the Validator.

---

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.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> struts >> [ validator overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---