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

Version:

$Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $

See Also:

Serialized Form

Field Summary

private java.util.Map	constants A Map of Constants using the name field of the Constant as the key.
private java.lang.String	country Country component of Locale (optional).
protected static int	COUNTRY_FORMSET This is the type of FormSets where only language and country locale are specified.
private java.util.Map	forms A Map of Forms using the name field of the Form as the key.
protected static int	GLOBAL_FORMSET This is the type of FormSets where no locale is specified.
private java.lang.String	language Language component of Locale (required).
protected static int	LANGUAGE_FORMSET This is the type of FormSets where only language locale is specified.
private org.apache.commons.logging.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 java.lang.String	variant Variant component of Locale (optional).
protected static int	VARIANT_FORMSET This is the type of FormSets where full locale has been set.

Constructor Summary

FormSet()

Method Summary

void	addConstant(java.lang.String name, java.lang.String value) Add a Constant to the locale level.
void	addForm(Form f) Add a Form to the FormSet.
java.lang.String	displayKey() Returns a string representation of the object's key.
java.lang.String	getCountry() Gets the equivalent of the country component of Locale.
Form	getForm(java.lang.String formName) Retrieve a Form based on the form name.
java.util.Map	getForms() A Map of Forms is returned as an unmodifiable Map with the key based on the form name.
java.lang.String	getLanguage() Gets the equivalent of the language component of Locale.
private org.apache.commons.logging.Log	getLog() Accessor method for Log instance.
protected int	getType() Returns the type of FormSet:GLOBAL_FORMSET, LANGUAGE_FORMSET,COUNTRY_FORMSET or VARIANT_FORMSET .
java.lang.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(java.util.Map globalConstants) Processes all of the Forms.
void	setCountry(java.lang.String country) Sets the equivalent of the country component of Locale.
void	setLanguage(java.lang.String language) Sets the equivalent of the language component of Locale.
void	setVariant(java.lang.String variant) Sets the equivalent of the variant component of Locale.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

private transient org.apache.commons.logging.Log log

Logging

processed

private boolean processed

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

language

private java.lang.String language

Language component of Locale (required).

country

private java.lang.String country

Country component of Locale (optional).

variant

private java.lang.String variant

Variant component of Locale (optional).

forms

private java.util.Map forms

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

constants

private java.util.Map constants

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

GLOBAL_FORMSET

protected static final int GLOBAL_FORMSET

This is the type of FormSets where no locale is specified.

See Also:

Constant Field Values

LANGUAGE_FORMSET

protected static final int LANGUAGE_FORMSET

This is the type of FormSets where only language locale is specified.

See Also:

Constant Field Values

COUNTRY_FORMSET

protected static final int COUNTRY_FORMSET

This is the type of FormSets 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 of FormSets 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).

Constructor Detail

FormSet

public FormSet()

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 of FormSet:GLOBAL_FORMSET, LANGUAGE_FORMSET,COUNTRY_FORMSET or VARIANT_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 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

isProcessed

public boolean isProcessed()

Whether or not the this FormSet 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 of Locale.

Returns:

The language value

setLanguage

public void setLanguage(java.lang.String language)

Sets the equivalent of the language component of Locale.

Parameters:

language - The new language value

getCountry

public java.lang.String getCountry()

Gets the equivalent of the country component of Locale.

Returns:

The country value

setCountry

public void setCountry(java.lang.String country)

Sets the equivalent of the country component of Locale.

Parameters:

country - The new country value

getVariant

public java.lang.String getVariant()

Gets the equivalent of the variant component of Locale.

Returns:

The variant value

setVariant

public void setVariant(java.lang.String variant)

Sets the equivalent of the variant component of Locale.

Parameters:

variant - The new variant value

addConstant

public void addConstant(java.lang.String name,
                        java.lang.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

getForm

public Form getForm(java.lang.String formName)

Retrieve a Form based on the form name.

Parameters:

formName - The form name

Returns:

The form

getForms

public java.util.Map getForms()

A Map of Forms is returned as an unmodifiable Map with the key based on the form name.

Returns:

The forms map

process

void process(java.util.Map globalConstants)

Processes all of the Forms.

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 class java.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.