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.

Version:

$Revision: 1.6 $ $Date: 2002/03/30 04:33:17 $

Author:

David Winterfeldt

See Also:

Serialized Form

Field Summary

private boolean	bProcessed Whether or not the this FormSet was processed for replacing variables in strings with their values.
private java.lang.String	country Country component of Locale (optional).
private org.apache.commons.collections.FastHashMap	hConstants A FastHashMap of Constants using the name field of the Constant as the key.
private org.apache.commons.collections.FastHashMap	hForms A FastHashMap of Forms using the name field of the Form as the key.
private java.lang.String	language Language component of Locale (required).
private java.lang.String	variant Variant component of Locale (optional).

Constructor Summary

FormSet()

Method Summary

void	addConstant(Constant c) Add a Constant (locale level).
void	addConstantParam(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	getCountry() Gets the equivalent of the country component of Locale.
Form	getForm(java.lang.Object key) 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.
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) Processes all of the Forms, set FastHashMaps to 'fast' mode.
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

bProcessed

private boolean bProcessed

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

hForms

private org.apache.commons.collections.FastHashMap hForms

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

hConstants

private org.apache.commons.collections.FastHashMap hConstants

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

Constructor Detail

FormSet

public FormSet()

Method Detail

isProcessed

public boolean isProcessed()

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

getLanguage

public java.lang.String getLanguage()

Gets the equivalent of the language component of Locale.

setLanguage

public void setLanguage(java.lang.String language)

Sets the equivalent of the language component of Locale.

getCountry

public java.lang.String getCountry()

Gets the equivalent of the country component of Locale.

setCountry

public void setCountry(java.lang.String country)

Sets the equivalent of the country component of Locale.

getVariant

public java.lang.String getVariant()

Gets the equivalent of the variant component of Locale.

setVariant

public void setVariant(java.lang.String variant)

Sets the equivalent of the variant component of Locale.

addConstant

public void addConstant(Constant c)

Add a Constant (locale level).

addConstantParam

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

Add a Constant to the locale level.

addForm

public void addForm(Form f)

Add a Form to the FormSet.

getForm

public Form getForm(java.lang.Object key)

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.

process

public void process(java.util.Map globalConstants)

Processes all of the Forms, set FastHashMaps to 'fast' mode.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object