Package org.apache.commons.validator
Class FormSet
- java.lang.Object
-
- org.apache.commons.validator.FormSet
-
- All Implemented Interfaces:
java.io.Serializable
public class FormSet extends java.lang.Object implements java.io.Serializable
Holds a set ofForm
s stored associated with aLocale
based on the country, language, and variant specified. Instances of this class are configured with a <formset> xml element.- Version:
- $Revision: 1713331 $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Map<java.lang.String,java.lang.String>
constants
AMap
ofConstant
s using the name field of theConstant
as the key.private java.lang.String
country
Country component ofLocale
(optional).protected static int
COUNTRY_FORMSET
This is the type ofFormSet
s where only language and country locale are specified.private java.util.Map<java.lang.String,Form>
forms
AMap
ofForm
s using the name field of theForm
as the key.protected static int
GLOBAL_FORMSET
This is the type ofFormSet
s where no locale is specified.private java.lang.String
language
Language component ofLocale
(required).protected static int
LANGUAGE_FORMSET
This is the type ofFormSet
s where only language locale is specified.private org.apache.commons.logging.Log
log
Loggingprivate boolean
merged
Flag indicating if this formSet has been merged with its parent (higher rank in Locale hierarchy).private boolean
processed
Whether or not the thisFormSet
was processed for replacing variables in strings with their values.private static long
serialVersionUID
private java.lang.String
variant
Variant component ofLocale
(optional).protected static int
VARIANT_FORMSET
This is the type ofFormSet
s where full locale has been set.
-
Constructor Summary
Constructors Constructor Description FormSet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addConstant(java.lang.String name, java.lang.String value)
Add aConstant
to the locale level.void
addForm(Form f)
Add aForm
to theFormSet
.java.lang.String
displayKey()
Returns a string representation of the object's key.java.lang.String
getCountry()
Gets the equivalent of the country component ofLocale
.Form
getForm(java.lang.String formName)
Retrieve aForm
based on the form name.java.util.Map<java.lang.String,Form>
getForms()
AMap
ofForm
s is returned as an unmodifiableMap
with the key based on the form name.java.lang.String
getLanguage()
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
.java.lang.String
getVariant()
Gets the equivalent of the variant component ofLocale
.protected boolean
isMerged()
Has this formSet been merged?boolean
isProcessed()
Whether or not the thisFormSet
was processed for replacing variables in strings with their values.protected void
merge(FormSet depends)
Merges the givenFormSet
into this one.(package private) void
process(java.util.Map<java.lang.String,java.lang.String> globalConstants)
Processes all of theForm
s.void
setCountry(java.lang.String country)
Sets the equivalent of the country component ofLocale
.void
setLanguage(java.lang.String language)
Sets the equivalent of the language component ofLocale
.void
setVariant(java.lang.String variant)
Sets the equivalent of the variant component ofLocale
.java.lang.String
toString()
Returns a string representation of the object.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
log
private transient org.apache.commons.logging.Log log
Logging
-
processed
private boolean processed
Whether or not the thisFormSet
was processed for replacing variables in strings with their values.
-
language
private java.lang.String language
Language component ofLocale
(required).
-
country
private java.lang.String country
Country component ofLocale
(optional).
-
variant
private java.lang.String variant
Variant component ofLocale
(optional).
-
forms
private final java.util.Map<java.lang.String,Form> forms
AMap
ofForm
s using the name field of theForm
as the key.
-
constants
private final java.util.Map<java.lang.String,java.lang.String> constants
AMap
ofConstant
s using the name field of theConstant
as the key.
-
GLOBAL_FORMSET
protected static final int GLOBAL_FORMSET
This is the type ofFormSet
s where no locale is specified.- See Also:
- Constant Field Values
-
LANGUAGE_FORMSET
protected static final int LANGUAGE_FORMSET
This is the type ofFormSet
s where only language locale is specified.- See Also:
- Constant Field Values
-
COUNTRY_FORMSET
protected static final int COUNTRY_FORMSET
This is the type ofFormSet
s where only language and country locale are specified.- See Also:
- Constant Field Values
-
VARIANT_FORMSET
protected static final int VARIANT_FORMSET
This is the type ofFormSet
s where full locale has been set.- See Also:
- Constant Field Values
-
merged
private boolean merged
Flag indicating if this formSet has been merged with its parent (higher rank in Locale hierarchy).
-
-
Method Detail
-
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:
java.lang.NullPointerException
- if there is inconsistency in the locale definition (not sure about this)- Since:
- Validator 1.2.0
-
merge
protected void merge(FormSet depends)
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
public java.lang.String getLanguage()
Gets the equivalent of the language component ofLocale
.- Returns:
- The language value
-
setLanguage
public void setLanguage(java.lang.String language)
Sets the equivalent of the language component ofLocale
.- Parameters:
language
- The new language value
-
getCountry
public java.lang.String getCountry()
Gets the equivalent of the country component ofLocale
.- Returns:
- The country value
-
setCountry
public void setCountry(java.lang.String country)
Sets the equivalent of the country component ofLocale
.- Parameters:
country
- The new country value
-
getVariant
public java.lang.String getVariant()
Gets the equivalent of the variant component ofLocale
.- Returns:
- The variant value
-
setVariant
public void setVariant(java.lang.String variant)
Sets the equivalent of the variant component ofLocale
.- Parameters:
variant
- The new variant value
-
addConstant
public void addConstant(java.lang.String name, java.lang.String value)
Add aConstant
to the locale level.- Parameters:
name
- The constant namevalue
- The constant value
-
addForm
public void addForm(Form f)
Add aForm
to theFormSet
.- Parameters:
f
- The form
-
getForm
public Form getForm(java.lang.String formName)
Retrieve aForm
based on the form name.- Parameters:
formName
- The form name- Returns:
- The form
-
getForms
public java.util.Map<java.lang.String,Form> getForms()
AMap
ofForm
s is returned as an unmodifiableMap
with the key based on the form name.- Returns:
- The forms map
-
process
void process(java.util.Map<java.lang.String,java.lang.String> globalConstants)
Processes all of theForm
s.- Parameters:
globalConstants
- Global constants
-
displayKey
public java.lang.String displayKey()
Returns a string representation of the object's key.- Returns:
- A string representation of the key
-
toString
public java.lang.String toString()
Returns a string representation of the object.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation
-
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.
-
-