org.apache.commons.validator
Class ValidatorResources

java.lang.Object
  |
  +--org.apache.commons.validator.ValidatorResources
All Implemented Interfaces:
java.io.Serializable

public class ValidatorResources
extends java.lang.Object
implements java.io.Serializable

General purpose class for storing FormSet objects based on their associated Locale.

IMPLEMENTATION NOTE - Classes that extend this class must be Serializable so that instances may be used in distributable application server environments.

Version:
$Revision: 1.13 $ $Date: 2003/03/20 02:33:34 $
Author:
David Winterfeldt, David Graham
See Also:
Serialized Form

Field Summary
protected static java.util.Locale defaultLocale
          The default locale on our server.
protected  org.apache.commons.collections.FastHashMap hActions
          FastHashMap of ValidatorActions with the name of the ValidatorAction as the key.
protected  org.apache.commons.collections.FastHashMap hConstants
          FastHashMap of global constant values with the name of the constant as the key.
protected  org.apache.commons.collections.FastHashMap hFormSets
          FastHashMap of FormSets stored under a Locale key.
protected static org.apache.commons.logging.Log log
          Logger.
 
Constructor Summary
ValidatorResources()
           
 
Method Summary
 void addConstant(Constant c)
          Add a global constant to the resource.
 void addConstantParam(java.lang.String name, java.lang.String value)
          Add a global constant to the resource.
 void addValidatorAction(ValidatorAction va)
          Add a ValidatorAction to the resource.
protected  java.lang.String buildKey(FormSet fs)
          Builds a key to store the FormSet under based on it's language, country, and variant values.
 Form get(java.util.Locale locale, java.lang.Object formKey)
          Gets a Form based on the name of the form and the Locale that most closely matches the Locale passed in.
 Form get(java.lang.String language, java.lang.String country, java.lang.String variant, java.lang.Object formKey)
          Gets a Form based on the name of the form and the Locale that most closely matches the Locale passed in.
protected  Field getClosestLocaleField(FormSet fs, java.lang.String formKey, java.lang.String fieldKey)
          Retrieves the closest matching Field based on FormSet's locale.
 ValidatorAction getValidatorAction(java.lang.String key)
          Get a ValidatorAction based on it's name.
 java.util.Map getValidatorActions()
          Get an unmodifiable Map of the ValidatorActions.
 void process()
          Process the ValidatorResources object.
 void processForms()
          Process the Form objects.
 void put(FormSet fs)
          Add a FormSet to this ValidatorResources object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static org.apache.commons.logging.Log log
Logger.


hFormSets

protected org.apache.commons.collections.FastHashMap hFormSets
FastHashMap of FormSets stored under a Locale key.


hConstants

protected org.apache.commons.collections.FastHashMap hConstants
FastHashMap of global constant values with the name of the constant as the key.


hActions

protected org.apache.commons.collections.FastHashMap hActions
FastHashMap of ValidatorActions with the name of the ValidatorAction as the key.


defaultLocale

protected static java.util.Locale defaultLocale
The default locale on our server.

Constructor Detail

ValidatorResources

public ValidatorResources()
Method Detail

put

public void put(FormSet fs)
Add a FormSet to this ValidatorResources object. It will be associated with the Locale of the FormSet.


addConstant

public void addConstant(Constant c)
Add a global constant to the resource.


addConstantParam

public void addConstantParam(java.lang.String name,
                             java.lang.String value)
Add a global constant to the resource.


addValidatorAction

public void addValidatorAction(ValidatorAction va)

Add a ValidatorAction to the resource. It also creates an instance of the class based on the ValidatorActions classname and retrieves the Method instance and sets them in the ValidatorAction.


getValidatorAction

public ValidatorAction getValidatorAction(java.lang.String key)
Get a ValidatorAction based on it's name.


getValidatorActions

public java.util.Map getValidatorActions()
Get an unmodifiable Map of the ValidatorActions.


buildKey

protected java.lang.String buildKey(FormSet fs)
Builds a key to store the FormSet under based on it's language, country, and variant values.


get

public Form get(java.util.Locale locale,
                java.lang.Object formKey)

Gets a Form based on the name of the form and the Locale that most closely matches the Locale passed in. The order of Locale matching is:

  1. language + country + variant
  2. language + country
  3. language
  4. default locale


get

public Form get(java.lang.String language,
                java.lang.String country,
                java.lang.String variant,
                java.lang.Object formKey)

Gets a Form based on the name of the form and the Locale that most closely matches the Locale passed in. The order of Locale matching is:

  1. language + country + variant
  2. language + country
  3. language
  4. default locale


process

public void process()

Process the ValidatorResources object.

Currently sets the FastHashMaps to the 'fast' mode and call the processes all other resources.


processForms

public void processForms()

Process the Form objects. This clones the Fields that don't exist in a FormSet compared to the default FormSet.


getClosestLocaleField

protected Field getClosestLocaleField(FormSet fs,
                                      java.lang.String formKey,
                                      java.lang.String fieldKey)
Retrieves the closest matching Field based on FormSet's locale. This is used when constructing a clone, field by field, of partial FormSet.



Copyright (c) 2001-2002 - Apache Software Foundation