org.apache.commons.validator

Class FormSet

Implemented Interfaces:
Serializable

public class FormSet
extends java.lang.Object
implements Serializable

Holds a set of Forms stored associated with a Locale based on the country, language, and variant specified. Instances of this class are configured with a <formset> xml element.

Field Summary

protected static int
COUNTRY_FORMSET
This is the type of FormSets where only language and country locale are specified.
protected static int
GLOBAL_FORMSET
This is the type of FormSets where no locale is specified.
protected static int
LANGUAGE_FORMSET
This is the type of FormSets where only language locale is specified.
protected static int
VARIANT_FORMSET
This is the type of FormSets where full locale has been set.
private Map
constants
A Map of Constants using the name field of the Constant as the key.
private String
country
Country component of Locale (optional).
private Map
forms
A Map of Forms using the name field of the Form as the key.
private String
language
Language component of Locale (required).
private Log
log
Logging
private 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 this FormSet was processed for replacing variables in strings with their values.
private String
variant
Variant component of Locale (optional).

Method Summary

void
addConstant(String name, String value)
Add a Constant to the locale level.
void
addForm(Form f)
Add a Form to the FormSet.
String
displayKey()
Returns a string representation of the object's key.
String
getCountry()
Gets the equivalent of the country component of Locale.
Form
getForm(String formName)
Retrieve a Form based on the form name.
Map
getForms()
A Map of Forms is returned as an unmodifiable Map with the key based on the form name.
String
getLanguage()
Gets the equivalent of the language component of Locale.
private Log
getLog()
Accessor method for Log instance.
protected int
getType()
Returns the type of FormSet:GLOBAL_FORMSET, LANGUAGE_FORMSET,COUNTRY_FORMSET or VARIANT_FORMSET .
String
getVariant()
Gets the equivalent of the variant component of Locale.
protected boolean
isMerged()
Has this formSet been merged?
boolean
isProcessed()
Whether or not the this FormSet was processed for replacing variables in strings with their values.
protected void
merge(FormSet depends)
Merges the given FormSet into this one.
(package private) void
process(Map globalConstants)
Processes all of the Forms.
void
setCountry(String country)
Sets the equivalent of the country component of Locale.
void
setLanguage(String language)
Sets the equivalent of the language component of Locale.
void
setVariant(String variant)
Sets the equivalent of the variant component of Locale.
String
toString()
Returns a string representation of the object.

Field Details

COUNTRY_FORMSET

protected static final int COUNTRY_FORMSET
This is the type of FormSets where only language and country locale are specified.
Field Value:
3

GLOBAL_FORMSET

protected static final int GLOBAL_FORMSET
This is the type of FormSets where no locale is specified.
Field Value:
1

LANGUAGE_FORMSET

protected static final int LANGUAGE_FORMSET
This is the type of FormSets where only language locale is specified.
Field Value:
2

VARIANT_FORMSET

protected static final int VARIANT_FORMSET
This is the type of FormSets where full locale has been set.
Field Value:
4

constants

private Map constants
A Map of Constants using the name field of the Constant as the key.

country

private String country
Country component of Locale (optional).

forms

private Map forms
A Map of Forms using the name field of the Form as the key.

language

private String language
Language component of Locale (required).

log

private Log log
Logging

merged

private boolean merged
Flag indicating if this formSet has been merged with its parent (higher rank in Locale hierarchy).

processed

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

variant

private String variant
Variant component of Locale (optional).

Method Details

addConstant

public void addConstant(String name,
                        String value)
Add a Constant to the locale level.
Parameters:
name - The constant name
value - The constant value

addForm

public void addForm(Form f)
Add a Form to the FormSet.
Parameters:
f - The form

displayKey

public String displayKey()
Returns a string representation of the object's key.
Returns:
A string representation of the key

getCountry

public String getCountry()
Gets the equivalent of the country component of Locale.
Returns:
The country value

getForm

public Form getForm(String formName)
Retrieve a Form based on the form name.
Parameters:
formName - The form name
Returns:
The form

getForms

public Map getForms()
A Map of Forms is returned as an unmodifiable Map with the key based on the form name.
Returns:
The forms map

getLanguage

public String getLanguage()
Gets the equivalent of the language component of Locale.
Returns:
The language value

getLog

private 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.

getType

protected int getType()
Returns the type of FormSet:GLOBAL_FORMSET, LANGUAGE_FORMSET,COUNTRY_FORMSET or VARIANT_FORMSET .
Returns:
The type value
Since:
Validator 1.2.0

getVariant

public String getVariant()
Gets the equivalent of the variant component of Locale.
Returns:
The variant value

isMerged

protected boolean isMerged()
Has this formSet been merged?
Returns:
true if it has been merged
Since:
Validator 1.2.0

isProcessed

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

merge

protected void merge(FormSet depends)
Merges the given FormSet into this one. If any of depends s Forms are not in this FormSet then, include them, else merge both Forms. Theoretically we should only merge a "parent" formSet.
Parameters:
depends - FormSet to be merged
Since:
Validator 1.2.0

process

(package private)  void process(Map globalConstants)
Processes all of the Forms.
Parameters:
globalConstants - Global constants

setCountry

public void setCountry(String country)
Sets the equivalent of the country component of Locale.
Parameters:
country - The new country value

setLanguage

public void setLanguage(String language)
Sets the equivalent of the language component of Locale.
Parameters:
language - The new language value

setVariant

public void setVariant(String variant)
Sets the equivalent of the variant component of Locale.
Parameters:
variant - The new variant value

toString

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

Copyright (c) 2001-2004 Apache Software Foundation