Package org.apache.struts.validator

Class ValidatorForm

java.lang.Object
org.apache.struts.action.ActionForm
org.apache.struts.validator.ValidatorForm
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BeanValidatorForm, 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.

  • See ValidatorPlugin definition in struts-config.xml for validation rules.
Since:
Struts 1.1
Version:
$Rev$ $Date: 2005-05-07 12:11:38 -0400 (Sat, 07 May 2005) $
See Also:

  • Field Details

    • 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 Details

    • ValidatorForm

      public ValidatorForm()

  • Method Details

    • 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, 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:

    • determinePage

      protected int determinePage(ActionMapping mapping, 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.4.1

    • 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

    • reset

      public void reset(ActionMapping mapping, 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 Map<String,Object> 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