public class Form extends 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.
| Modifier and Type | Field and Description |
|---|---|
protected org.apache.commons.collections.FastHashMap |
hFields
Deprecated.
Subclasses should use getFieldMap() instead.
|
protected String |
inherit
The name/key of the form which this form extends from.
|
protected List<Field> |
lFields
List of
Fields. |
protected String |
name
The name/key the set of validation rules is stored under.
|
| Constructor and Description |
|---|
Form() |
| Modifier and Type | Method and Description |
|---|---|
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<String,Field> |
getFieldMap()
Returns a Map of String field keys to Field objects.
|
List<Field> |
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<String,String> globalConstants,
Map<String,String> constants,
Map<String,Form> 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.
|
protected String name
protected List<Field> lFields
Fields. Used to maintain the order they were added
in although individual Fields can be retrieved using Map
of Fields.@Deprecated protected org.apache.commons.collections.FastHashMap hFields
Fields keyed on their property value.protected String inherit
public String getName()
public void setName(String name)
name - The new name valuepublic void addField(Field f)
Field to the Form.f - The fieldpublic List<Field> getFields()
List of Fields is returned as an unmodifiable
List.public Field getField(String fieldName)
fieldName - The field namepublic boolean containsField(String fieldName)
fieldName - The field nameprotected void merge(Form depends)
depends
not present in this form, include it. depends has precedence
in the way the fields are ordered.depends - the form we want to mergeprotected void process(Map<String,String> globalConstants, Map<String,String> constants, Map<String,Form> forms)
Form's Fields.globalConstants - A map of global constantsconstants - Local constantsforms - Map of formspublic String toString()
public boolean isProcessed()
Form was processed for replacing
variables in strings with their values.public String getExtends()
public void setExtends(String inherit)
inherit - The new extends valuepublic boolean isExtending()
Copyright © 2002–2020 The Apache Software Foundation. All rights reserved.