Package org.apache.commons.validator
Class Form
java.lang.Object
org.apache.commons.validator.Form
- All Implemented Interfaces:
Serializable
This contains a set of validation rules for a form/JavaBean. The information
is contained in a list of Field
objects. Instances of this class
are configured with a <form> xml element.
The use of FastHashMap is deprecated and will be replaced in a future release.
- Version:
- $Revision: 1713331 $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.apache.commons.collections.FastHashMap
Deprecated.Subclasses should use getFieldMap() instead.protected String
The name/key of the form which this form extends from.List ofField
s.protected String
The name/key the set of validation rules is stored under.private boolean
Whether or not the thisForm
was processed for replacing variables in strings with their values.private static final long
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add aField
to theForm
.boolean
containsField
(String fieldName) Returns true if this Form contains a Field with the given name.Gets the name/key of the parent set of validation rules.Returns the Field with the given name or null if this Form has no such field.Returns a Map of String field keys to Field objects.AList
ofField
s is returned as an unmodifiableList
.getName()
Gets the name/key of the set of validation rules.boolean
Get extends flag.boolean
Whether or not the thisForm
was processed for replacing variables in strings with their values.protected void
Merges the given form into this one.protected void
Processes all of theForm
'sField
s.void
setExtends
(String inherit) Sets the name/key of the parent set of validation rules.void
Sets the name/key of the set of validation rules.toString()
Returns a string representation of the object.(package private) ValidatorResults
Validate all Fields in this Form on the given page and below.(package private) ValidatorResults
validate
(Map<String, Object> params, Map<String, ValidatorAction> actions, int page, String fieldName) Validate all Fields in this Form on the given page and below.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
name
The name/key the set of validation rules is stored under. -
lFields
List ofField
s. Used to maintain the order they were added in although individualField
s can be retrieved usingMap
ofField
s. -
hFields
protected org.apache.commons.collections.FastHashMap hFieldsDeprecated.Subclasses should use getFieldMap() instead.Map ofField
s keyed on their property value. -
inherit
The name/key of the form which this form extends from.- Since:
- Validator 1.2.0
-
processed
private boolean processedWhether or not the thisForm
was processed for replacing variables in strings with their values.
-
-
Constructor Details
-
Form
public Form()
-
-
Method Details
-
getName
Gets the name/key of the set of validation rules.- Returns:
- The name value
-
setName
Sets the name/key of the set of validation rules.- Parameters:
name
- The new name value
-
addField
Add aField
to theForm
.- Parameters:
f
- The field
-
getFields
AList
ofField
s is returned as an unmodifiableList
.- Returns:
- The fields value
-
getField
Returns the Field with the given name or null if this Form has no such field.- Parameters:
fieldName
- The field name- Returns:
- The field value
- Since:
- Validator 1.1
-
containsField
Returns true if this Form contains a Field with the given name.- Parameters:
fieldName
- The field name- Returns:
- True if this form contains the field by the given name
- Since:
- Validator 1.1
-
merge
Merges the given form into this one. For any field independs
not present in this form, include it.depends
has precedence in the way the fields are ordered.- Parameters:
depends
- the form we want to merge- Since:
- Validator 1.2.0
-
process
protected void process(Map<String, String> globalConstants, Map<String, String> constants, Map<String, Form> forms) Processes all of theForm
'sField
s.- Parameters:
globalConstants
- A map of global constantsconstants
- Local constantsforms
- Map of forms- Since:
- Validator 1.2.0
-
toString
Returns a string representation of the object. -
validate
ValidatorResults validate(Map<String, Object> params, Map<String, throws ValidatorExceptionValidatorAction> actions, int page) Validate all Fields in this Form on the given page and below.- Parameters:
params
- A Map of parameter class names to parameter values to pass into validation methods.actions
- A Map of validator names to ValidatorAction objects.page
- Fields on pages higher than this will not be validated.- Returns:
- A ValidatorResults object containing all validation messages.
- Throws:
ValidatorException
-
validate
ValidatorResults validate(Map<String, Object> params, Map<String, throws ValidatorExceptionValidatorAction> actions, int page, String fieldName) Validate all Fields in this Form on the given page and below.- Parameters:
params
- A Map of parameter class names to parameter values to pass into validation methods.actions
- A Map of validator names to ValidatorAction objects.page
- Fields on pages higher than this will not be validated.- Returns:
- A ValidatorResults object containing all validation messages.
- Throws:
ValidatorException
- Since:
- 1.2.0
-
isProcessed
public boolean isProcessed()Whether or not the thisForm
was processed for replacing variables in strings with their values.- Returns:
- The processed value
- Since:
- Validator 1.2.0
-
getExtends
Gets the name/key of the parent set of validation rules.- Returns:
- The extends value
- Since:
- Validator 1.2.0
-
setExtends
Sets the name/key of the parent set of validation rules.- Parameters:
inherit
- The new extends value- Since:
- Validator 1.2.0
-
isExtending
public boolean isExtending()Get extends flag.- Returns:
- The extending value
- Since:
- Validator 1.2.0
-
getFieldMap
Returns a Map of String field keys to Field objects.- Returns:
- The fieldMap value
- Since:
- Validator 1.2.0
-