Package org.apache.commons.validator
Class FormSet
java.lang.Object
org.apache.commons.validator.FormSet
- All Implemented Interfaces:
Serializable
Holds a set of
Form
s stored associated with a Locale
based on the country, language, and variant specified. Instances of this
class are configured with a <formset> xml element.- Version:
- $Revision: 1713331 $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionAMap
ofConstant
s using the name field of theConstant
as the key.private String
Country component ofLocale
(optional).protected static final int
This is the type ofFormSet
s where only language and country locale are specified.AMap
ofForm
s using the name field of theForm
as the key.protected static final int
This is the type ofFormSet
s where no locale is specified.private String
Language component ofLocale
(required).protected static final int
This is the type ofFormSet
s where only language locale is specified.private org.apache.commons.logging.Log
Loggingprivate boolean
Flag indicating if this formSet has been merged with its parent (higher rank in Locale hierarchy).private boolean
Whether or not the thisFormSet
was processed for replacing variables in strings with their values.private static final long
private String
Variant component ofLocale
(optional).protected static final int
This is the type ofFormSet
s where full locale has been set. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addConstant
(String name, String value) Add aConstant
to the locale level.void
Add aForm
to theFormSet
.Returns a string representation of the object's key.Gets the equivalent of the country component ofLocale
.Retrieve aForm
based on the form name.getForms()
AMap
ofForm
s is returned as an unmodifiableMap
with the key based on the form name.Gets the equivalent of the language component ofLocale
.private org.apache.commons.logging.Log
getLog()
Accessor method for Log instance.protected int
getType()
Returns the type ofFormSet
:GLOBAL_FORMSET
,LANGUAGE_FORMSET
,COUNTRY_FORMSET
orVARIANT_FORMSET
.Gets the equivalent of the variant component ofLocale
.protected boolean
isMerged()
Has this formSet been merged?boolean
Whether or not the thisFormSet
was processed for replacing variables in strings with their values.protected void
Merges the givenFormSet
into this one.(package private) void
Processes all of theForm
s.void
setCountry
(String country) Sets the equivalent of the country component ofLocale
.void
setLanguage
(String language) Sets the equivalent of the language component ofLocale
.void
setVariant
(String variant) Sets the equivalent of the variant component ofLocale
.toString()
Returns a string representation of the object.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
log
private transient org.apache.commons.logging.Log logLogging -
processed
private boolean processedWhether or not the thisFormSet
was processed for replacing variables in strings with their values. -
language
Language component ofLocale
(required). -
country
Country component ofLocale
(optional). -
variant
Variant component ofLocale
(optional). -
forms
AMap
ofForm
s using the name field of theForm
as the key. -
constants
AMap
ofConstant
s using the name field of theConstant
as the key. -
GLOBAL_FORMSET
protected static final int GLOBAL_FORMSETThis is the type ofFormSet
s where no locale is specified.- See Also:
-
LANGUAGE_FORMSET
protected static final int LANGUAGE_FORMSETThis is the type ofFormSet
s where only language locale is specified.- See Also:
-
COUNTRY_FORMSET
protected static final int COUNTRY_FORMSETThis is the type ofFormSet
s where only language and country locale are specified.- See Also:
-
VARIANT_FORMSET
protected static final int VARIANT_FORMSETThis is the type ofFormSet
s where full locale has been set.- See Also:
-
merged
private boolean mergedFlag indicating if this formSet has been merged with its parent (higher rank in Locale hierarchy).
-
-
Constructor Details
-
FormSet
public FormSet()
-
-
Method Details
-
isMerged
protected boolean isMerged()Has this formSet been merged?- Returns:
- true if it has been merged
- Since:
- Validator 1.2.0
-
getType
protected int getType()Returns the type ofFormSet
:GLOBAL_FORMSET
,LANGUAGE_FORMSET
,COUNTRY_FORMSET
orVARIANT_FORMSET
.- Returns:
- The type value
- Throws:
NullPointerException
- if there is inconsistency in the locale definition (not sure about this)- Since:
- Validator 1.2.0
-
merge
Merges the givenFormSet
into this one. If any ofdepends
sForms
are not in thisFormSet
then, include them, else merge bothForms
. Theoretically we should only merge a "parent" formSet.- Parameters:
depends
- FormSet to be merged- Since:
- Validator 1.2.0
-
isProcessed
public boolean isProcessed()Whether or not the thisFormSet
was processed for replacing variables in strings with their values.- Returns:
- The processed value
-
getLanguage
Gets the equivalent of the language component ofLocale
.- Returns:
- The language value
-
setLanguage
Sets the equivalent of the language component ofLocale
.- Parameters:
language
- The new language value
-
getCountry
Gets the equivalent of the country component ofLocale
.- Returns:
- The country value
-
setCountry
Sets the equivalent of the country component ofLocale
.- Parameters:
country
- The new country value
-
getVariant
Gets the equivalent of the variant component ofLocale
.- Returns:
- The variant value
-
setVariant
Sets the equivalent of the variant component ofLocale
.- Parameters:
variant
- The new variant value
-
addConstant
Add aConstant
to the locale level.- Parameters:
name
- The constant namevalue
- The constant value
-
addForm
Add aForm
to theFormSet
.- Parameters:
f
- The form
-
getForm
Retrieve aForm
based on the form name.- Parameters:
formName
- The form name- Returns:
- The form
-
getForms
AMap
ofForm
s is returned as an unmodifiableMap
with the key based on the form name.- Returns:
- The forms map
-
process
Processes all of theForm
s.- Parameters:
globalConstants
- Global constants
-
displayKey
Returns a string representation of the object's key.- Returns:
- A string representation of the key
-
toString
Returns a string representation of the object. -
getLog
private org.apache.commons.logging.Log getLog()Accessor method for Log instance. The Log instance variable is transient and accessing it through this method ensures it is re-initialized when this instance is de-serialized.- Returns:
- The Log instance.
-