org.apache.commons.validator

Class FormSet

java.lang.Object

org.apache.commons.validator.FormSet

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.

See Also:: Serialized Form

Field Summary
`private java.util.Map`	`constants` A `Map` of `Constant`s using the name field of the `Constant` as the key.
`private java.lang.String`	`country` Country component of `Locale` (optional).
`private java.util.Map`	`forms` A `Map` of `Form`s using the name field of the `Form` as the key.
`private java.lang.String`	`language` Language component of `Locale` (required).
`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).

Method Summary
`void`	`addConstant(java.lang.String name, java.lang.String value)` Add a `Constant` to the locale level.
`void`	`addConstant(Constant c)` Deprecated. Use addConstant(String, String) instead.
`void`	`addConstantParam(java.lang.String name, java.lang.String value)` Deprecated. Use addConstant(String, String) instead.
`void`	`addForm(Form f)` Add a `Form` to the `FormSet`.
`java.lang.String`	`getCountry()` Gets the equivalent of the country component of `Locale`.
`Form`	`getForm(java.lang.Object key)` Deprecated. Use getForm(String) instead.
`Form`	`getForm(java.lang.String formName)` Retrieve a `Form` based on the form name.
`java.util.Map`	`getForms()` A `Map` of `Form`s 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`.
`java.lang.String`	`getVariant()` Gets the equivalent of the variant component of `Locale`.
`boolean`	`isProcessed()` Whether or not the this `FormSet` was processed for replacing variables in strings with their values.
`void`	`process(java.util.Map globalConstants)` Deprecated. This method is called by the framework.
`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.

constants

private java.util.Map constants

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

country

private java.lang.String country

Country component of Locale (optional).

forms

private java.util.Map forms

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

language

private java.lang.String language

Language component of Locale (required).

processed

private boolean processed

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

variant

private java.lang.String variant

Variant component of Locale (optional).

addConstant

public void addConstant(java.lang.String name,
                        java.lang.String value)

Add a Constant to the locale level.

addConstant

public void addConstant(Constant c)

Deprecated. Use addConstant(String, String) instead.
Add a Constant (locale level).

addConstantParam

public void addConstantParam(java.lang.String name,
                             java.lang.String value)

Deprecated. Use addConstant(String, String) instead.
Add a Constant to the locale level.

addForm

public void addForm(Form f)

Add a Form to the FormSet.

getCountry

public java.lang.String getCountry()

Gets the equivalent of the country component of Locale.

getForm

public Form getForm(java.lang.Object key)

Deprecated. Use getForm(String) instead.
Retrieve a Form based on the form name.

getForm

public Form getForm(java.lang.String formName)

Retrieve a Form based on the form name.

getForms

public java.util.Map getForms()

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

getLanguage

public java.lang.String getLanguage()

Gets the equivalent of the language component of Locale.

getVariant

public java.lang.String getVariant()

Gets the equivalent of the variant component of Locale.

isProcessed

public boolean isProcessed()

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

process

public void process(java.util.Map globalConstants)

Deprecated. This method is called by the framework. It will be made protected in a future release. TODO
Processes all of the Forms.

setCountry

public void setCountry(java.lang.String country)

Sets the equivalent of the country component of Locale.

setLanguage

public void setLanguage(java.lang.String language)

Sets the equivalent of the language component of Locale.

setVariant

public void setVariant(java.lang.String variant)

Sets the equivalent of the variant component of Locale.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overview Package Tree Index Deprecated About
Prev Class \| Next Class	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr

org.apache.commons.validator

Class FormSet

Field Summary

Method Summary

Field Details

constants

country

forms

language

processed

variant

Method Details

addConstant

addConstant

addConstantParam

addForm

getCountry

getForm

getForm

getForms

getLanguage

getVariant

isProcessed

process

setCountry

setLanguage

setVariant

toString