Class VisitorFieldValidator

All Implemented Interfaces:
FieldValidator, ShortCircuitableValidator, Validator
Direct Known Subclasses:
ConditionalVisitorFieldValidator

public class VisitorFieldValidator extends FieldValidatorSupport

The VisitorFieldValidator allows you to forward validation to object properties of your action using the object's own validation files. This allows you to use the ModelDriven development pattern and manage your validations for your models in one place, where they belong, next to your model classes. The VisitorFieldValidator can handle either simple Object properties, Collections of Objects, or Arrays.

  • fieldName - field name if plain-validator syntax is used, not needed if field-validator syntax is used
  • context - the context of which validation should take place. Optional
  • appendPrefix - the prefix to be added to field. Optional
 
    <validators>
        <!-- Plain Validator Syntax -->
        <validator type="visitor">
            <param name="fieldName">user</param>
            <param name="context">myContext</param>
            <param name="appendPrefix">true</param>
        </validator>

        <!-- Field Validator Syntax -->
        <field name="user">
           <field-validator type="visitor">
              <param name="context">myContext</param>
              <param name="appendPrefix">true</param>
           </field-validator>
        </field>
    </validators>
 
 

In the example above, if the action's getUser() method return User object, XWork will look for User-myContext-validation.xml for the validators. Since appednPrefix is true, every field name will be prefixed with 'user' such that if the actual field name for 'name' is 'user.name'

Author:
Jason Carreira, Rainer Hermanns
  • Constructor Details

    • VisitorFieldValidator

      public VisitorFieldValidator()
  • Method Details

    • setActionValidatorManager

      public void setActionValidatorManager(ActionValidatorManager mgr)
    • setAppendPrefix

      public void setAppendPrefix(boolean appendPrefix)
      Parameters:
      appendPrefix - whether the field name of this field validator should be prepended to the field name of the visited field to determine the full field name when an error occurs. The default is true.
    • isAppendPrefix

      public boolean isAppendPrefix()
      Returns:
      whether the field name of this field validator should be prepended to the field name of the visited field to determine the full field name when an error occurs. The default is true.
    • setContext

      public void setContext(String context)
    • getContext

      public String getContext()
    • validate

      public void validate(Object object) throws ValidationException
      Description copied from interface: Validator
      The validation implementation must guarantee that setValidatorContext will be called with a non-null ValidatorContext before validate is called.
      Parameters:
      object - the object to be validated.
      Throws:
      ValidationException - is thrown if there is validation error(s).