org.apache.commons.validator

Class Form

Implemented Interfaces:
Serializable

public class Form
extends java.lang.Object
implements 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.

Field Summary

protected FastHashMap
hFields
Deprecated. Subclasses should use getFieldMap() instead.
protected String
inherit
The name/key of the form which this form extends from.
protected List
lFields
List of Fields.
protected String
name
The name/key the set of validation rules is stored under.
private boolean
processed
Whether or not the this Form was processed for replacing variables in strings with their values.

Method Summary

void
addField(Field f)
Add a Field to the Form.
boolean
containsField(String fieldName)
Returns true if this Form contains a Field with the given name.
String
getExtends()
Gets the name/key of the parent set of validation rules.
Field
getField(String fieldName)
Returns the Field with the given name or null if this Form has no such field.
protected Map
getFieldMap()
Returns a Map of String field keys to Field objects.
List
getFields()
A List of Fields is returned as an unmodifiable List.
String
getName()
Gets the name/key of the set of validation rules.
boolean
isExtending()
Get extends flag.
boolean
isProcessed()
Whether or not the this Form was processed for replacing variables in strings with their values.
protected void
merge(Form depends)
Merges the given form into this one.
protected void
process(Map globalConstants, Map constants, Map forms)
Processes all of the Form's Fields.
void
setExtends(String inherit)
Sets the name/key of the parent set of validation rules.
void
setName(String name)
Sets the name/key of the set of validation rules.
String
toString()
Returns a string representation of the object.
(package private) ValidatorResults
validate(Map params, Map actions, int page)
Validate all Fields in this Form on the given page and below.
(package private) ValidatorResults
validate(Map params, Map actions, int page, String fieldName)
Validate all Fields in this Form on the given page and below.

Field Details

hFields

protected FastHashMap hFields

Deprecated. Subclasses should use getFieldMap() instead.

Map of Fields keyed on their property value.

inherit

protected String inherit
The name/key of the form which this form extends from.
Since:
Validator 1.2.0

lFields

protected List lFields
List of Fields. Used to maintain the order they were added in although individual Fields can be retrieved using Map of Fields.

name

protected String name
The name/key the set of validation rules is stored under.

processed

private boolean processed
Whether or not the this Form was processed for replacing variables in strings with their values.

Method Details

addField

public void addField(Field f)
Add a Field to the Form.
Parameters:
f - The field

containsField

public boolean containsField(String fieldName)
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

getExtends

public String getExtends()
Gets the name/key of the parent set of validation rules.
Returns:
The extends value
Since:
Validator 1.2.0

getField

public Field getField(String fieldName)
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

getFieldMap

protected Map getFieldMap()
Returns a Map of String field keys to Field objects.
Returns:
The fieldMap value
Since:
Validator 1.2.0

getFields

public List getFields()
A List of Fields is returned as an unmodifiable List.
Returns:
The fields value

getName

public String getName()
Gets the name/key of the set of validation rules.
Returns:
The name value

isExtending

public boolean isExtending()
Get extends flag.
Returns:
The extending value
Since:
Validator 1.2.0

isProcessed

public boolean isProcessed()
Whether or not the this Form was processed for replacing variables in strings with their values.
Returns:
The processed value
Since:
Validator 1.2.0

merge

protected void merge(Form depends)
Merges the given form into this one. For any field in depends 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 globalConstants,
                       Map constants,
                       Map forms)
Processes all of the Form's Fields.
Parameters:
globalConstants - A map of global constants
constants - Local constants
forms - Map of forms
Since:
Validator 1.2.0

setExtends

public void setExtends(String inherit)
Sets the name/key of the parent set of validation rules.
Parameters:
inherit - The new extends value
Since:
Validator 1.2.0

setName

public void setName(String name)
Sets the name/key of the set of validation rules.
Parameters:
name - The new name value

toString

public String toString()
Returns a string representation of the object.
Returns:
string representation

validate

(package private)  ValidatorResults validate(Map params,
                                             Map actions,
                                             int page)
            throws ValidatorException
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.

validate

(package private)  ValidatorResults validate(Map params,
                                             Map actions,
                                             int page,
                                             String fieldName)
            throws ValidatorException
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.
Since:
1.2.0

Copyright (c) 2001-2004 Apache Software Foundation