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.
<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'
Modifier and Type | Class and Description |
---|---|
static class |
VisitorFieldValidator.AppendingValidatorContext |
currentValue, fieldName, type
defaultMessage, EMPTY_STRING, messageKey, stack, textProviderFactory
Constructor and Description |
---|
VisitorFieldValidator() |
Modifier and Type | Method and Description |
---|---|
String |
getContext() |
boolean |
isAppendPrefix() |
void |
setActionValidatorManager(ActionValidatorManager mgr) |
void |
setAppendPrefix(boolean appendPrefix) |
void |
setContext(String context) |
void |
validate(Object object)
The validation implementation must guarantee that setValidatorContext will
be called with a non-null ValidatorContext before validate is called.
|
getCurrentValue, getFieldName, getValidatorType, setFieldName, setValidatorType
addActionError, addFieldError, getDefaultMessage, getFieldValue, getMessage, getMessageKey, getMessageParameters, getValidatorContext, isShortCircuit, parse, setDefaultMessage, setMessageKey, setMessageParameters, setShortCircuit, setTextProviderFactory, setValidatorContext, setValueStack
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDefaultMessage, getMessage, getMessageKey, getMessageParameters, getValidatorContext, setDefaultMessage, setMessageKey, setMessageParameters, setValidatorContext, setValueStack
public void setActionValidatorManager(ActionValidatorManager mgr)
public void setAppendPrefix(boolean appendPrefix)
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.public boolean isAppendPrefix()
public void setContext(String context)
public String getContext()
public void validate(Object object) throws ValidationException
Validator
object
- the object to be validated.ValidationException
- is thrown if there is validation error(s).Copyright © 2000–2020 Apache Software Foundation. All rights reserved.