| java.lang.Object
 org.apache.commons.validator.ValidatorResources
All known Subclasses: org.apache.commons.validator.custom.CustomValidatorResources,
| ValidatorResources | | public class ValidatorResources implements Serializable(Code) | |
General purpose class for storing FormSet objects based
on their associated Locale. Instances of this class are usually
configured through a validation.xml file that is parsed in a constructor.
Note - Classes that extend this class
must be Serializable so that instances may be used in distributable
application server environments.
The use of FastHashMap is deprecated and will be replaced in a future
release.
version:
$Revision: 478473 $ $Date: 2006-11-23 05:42:30 +0000 (Thu, 23 Nov 2006) $ |
| Field Summary | |
| protected FormSet | defaultFormSet
This is the default FormSet (without locale). | | protected static Locale | defaultLocale
The default locale on our server. | | protected FastHashMap | hActions
Map of ValidatorActions with
the name of the ValidatorAction as the key. | | protected FastHashMap | hConstants
Map of global constant values with
the name of the constant as the key. | | protected FastHashMap | hFormSets
Map of FormSets stored under
a Locale key. |
| Method Summary | |
| public void | addConstant(String name, String value)
Add a global constant to the resource. | | public void | addFormSet(FormSet fs)
Add a FormSet to this ValidatorResources
object. | | public void | addValidatorAction(ValidatorAction va)
Add a ValidatorAction to the resource. | | protected String | buildKey(FormSet fs)
Builds a key to store the FormSet under based on it's
language, country, and variant values.
Parameters:
fs - The Form Set. | | protected Map | getActions()
Returns a Map of String ValidatorAction names to their ValidatorAction. | | protected Map | getConstants()
Returns a Map of String constant names to their String values. | | public Form | getForm(Locale locale, String formKey)
Gets a Form based on the name of the form and the
Locale that most closely matches the Locale
passed in. | | public Form | getForm(String language, String country, String variant, String formKey)
Gets a Form based on the name of the form and the
Locale that most closely matches the Locale
passed in. | | FormSet | getFormSet(String language, String country, String variant)
Gets a FormSet based on the language, country
and variant.
Parameters:
language - The locale's language.
Parameters:
country - The locale's country.
Parameters:
variant - The locale's language variant. | | protected Map | getFormSets()
Returns a Map of String locale keys to Lists of their FormSets. | | public ValidatorAction | getValidatorAction(String key)
Get a ValidatorAction based on it's name.
Parameters:
key - The validator action key. | | public Map | getValidatorActions()
Get an unmodifiable Map of the ValidatorActions. | | public void | process()
Process the ValidatorResources object. |
| defaultFormSet | | protected FormSet defaultFormSet(Code) | | This is the default FormSet (without locale). (We probably don't need
the defaultLocale anymore.)
|
| defaultLocale | | protected static Locale defaultLocale(Code) | | The default locale on our server.
|
| hActions | | protected FastHashMap hActions(Code) | | Map of ValidatorActions with
the name of the ValidatorAction as the key.
|
| hConstants | | protected FastHashMap hConstants(Code) | | Map of global constant values with
the name of the constant as the key.
|
| hFormSets | | protected FastHashMap hFormSets(Code) | | Map of FormSets stored under
a Locale key.
|
| ValidatorResources | | public ValidatorResources()(Code) | | Create an empty ValidatorResources object.
|
| ValidatorResources | | public ValidatorResources(InputStream in) throws IOException, SAXException(Code) | | Create a ValidatorResources object from an InputStream.
Parameters:
in - InputStream to a validation.xml configuration file. It's the client'sresponsibility to close this stream.
throws:
IOException -
throws:
SAXException - if the validation XML files are not valid or wellformed.
throws:
IOException - if an I/O error occurs processing the XML files
since:
Validator 1.1 |
| ValidatorResources | | public ValidatorResources(InputStream[] streams) throws IOException, SAXException(Code) | | Create a ValidatorResources object from an InputStream.
Parameters:
streams - An array of InputStreams to several validation.xmlconfiguration files that will be read in order and merged into this object.It's the client's responsibility to close these streams.
throws:
IOException -
throws:
SAXException - if the validation XML files are not valid or wellformed.
throws:
IOException - if an I/O error occurs processing the XML files
since:
Validator 1.1 |
| ValidatorResources | | public ValidatorResources(String uri) throws IOException, SAXException(Code) | | Create a ValidatorResources object from an uri
Parameters:
uri - The location of a validation.xml configuration file.
throws:
IOException -
throws:
SAXException - if the validation XML files are not valid or wellformed.
throws:
IOException - if an I/O error occurs processing the XML files
since:
Validator 1.2 |
| ValidatorResources | | public ValidatorResources(String[] uris) throws IOException, SAXException(Code) | | Create a ValidatorResources object from several uris
Parameters:
uris - An array of uris to several validation.xmlconfiguration files that will be read in order and merged into this object.
throws:
IOException -
throws:
SAXException - if the validation XML files are not valid or wellformed.
throws:
IOException - if an I/O error occurs processing the XML files
since:
Validator 1.2 |
| ValidatorResources | | public ValidatorResources(URL url) throws IOException, SAXException(Code) | | Create a ValidatorResources object from a URL.
Parameters:
url - The URL for the validation.xmlconfiguration file that will be read into this object.
throws:
IOException -
throws:
SAXException - if the validation XML file are not valid or wellformed.
throws:
IOException - if an I/O error occurs processing the XML files
since:
Validator 1.3.1 |
| ValidatorResources | | public ValidatorResources(URL[] urls) throws IOException, SAXException(Code) | | Create a ValidatorResources object from several URL.
Parameters:
urls - An array of URL to several validation.xmlconfiguration files that will be read in order and merged into this object.
throws:
IOException -
throws:
SAXException - if the validation XML files are not valid or wellformed.
throws:
IOException - if an I/O error occurs processing the XML files
since:
Validator 1.3.1 |
| addConstant | | public void addConstant(String name, String value)(Code) | | Add a global constant to the resource.
Parameters:
name - The constant name.
Parameters:
value - The constant value. |
| addFormSet | | public void addFormSet(FormSet fs)(Code) | | Add a FormSet to this ValidatorResources
object. It will be associated with the Locale of the
FormSet.
Parameters:
fs - The form set to add.
since:
Validator 1.1 |
| addValidatorAction | | public void addValidatorAction(ValidatorAction va)(Code) | | 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.
Parameters:
va - The validator action. |
| buildKey | | protected String buildKey(FormSet fs)(Code) | | Builds a key to store the FormSet under based on it's
language, country, and variant values.
Parameters:
fs - The Form Set. generated key for a formset. |
| getActions | | protected Map getActions()(Code) | | Returns a Map of String ValidatorAction names to their ValidatorAction.
Map of Validator Actions
since:
Validator 1.2.0 |
| getConstants | | protected Map getConstants()(Code) | | Returns a Map of String constant names to their String values.
Map of Constants
since:
Validator 1.2.0 |
| getForm | | public Form getForm(Locale locale, String formKey)(Code) | | 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:
- language + country + variant
- language + country
- language
- default locale
Parameters:
locale - The Locale.
Parameters:
formKey - The key for the Form. The validator Form.
since:
Validator 1.1 |
| getForm | | public Form getForm(String language, String country, String variant, String formKey)(Code) | | 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:
- language + country + variant
- language + country
- language
- default locale
Parameters:
language - The locale's language.
Parameters:
country - The locale's country.
Parameters:
variant - The locale's language variant.
Parameters:
formKey - The key for the Form. The validator Form.
since:
Validator 1.1 |
| getFormSet | | FormSet getFormSet(String language, String country, String variant)(Code) | | Gets a FormSet based on the language, country
and variant.
Parameters:
language - The locale's language.
Parameters:
country - The locale's country.
Parameters:
variant - The locale's language variant. The FormSet for a locale.
since:
Validator 1.2 |
| getFormSets | | protected Map getFormSets()(Code) | | Returns a Map of String locale keys to Lists of their FormSets.
Map of Form sets
since:
Validator 1.2.0 |
| getValidatorAction | | public ValidatorAction getValidatorAction(String key)(Code) | | Get a ValidatorAction based on it's name.
Parameters:
key - The validator action key. The validator action. |
| getValidatorActions | | public Map getValidatorActions()(Code) | | Get an unmodifiable Map of the ValidatorActions.
Map of validator actions. |
| process | | public void process()(Code) | | Process the ValidatorResources object. Currently sets the
FastHashMap s to the 'fast' mode and call the processes
all other resources. Note : The framework calls this
automatically when ValidatorResources is created from an XML file. If you
create an instance of this class by hand you must call
this method when finished.
|
|
|