Package org.apache.commons.validator
Class ValidatorResources
java.lang.Object
org.apache.commons.validator.ValidatorResources
- All Implemented Interfaces:
Serializable
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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected FormSetThis is the defaultFormSet(without locale).protected static LocaleThe default locale on our server.protected org.apache.commons.collections.FastHashMapDeprecated.Subclasses should use getActions() instead.protected org.apache.commons.collections.FastHashMapDeprecated.Subclasses should use getConstants() instead.protected org.apache.commons.collections.FastHashMapDeprecated.Subclasses should use getFormSets() instead. -
Constructor Summary
ConstructorsConstructorDescriptionCreate an empty ValidatorResources object.Create a ValidatorResources object from an InputStream.ValidatorResources(InputStream[] streams) Create a ValidatorResources object from an InputStream.ValidatorResources(String uri) Create a ValidatorResources object from an uriValidatorResources(String... uris) Create a ValidatorResources object from several urisValidatorResources(URL url) Create a ValidatorResources object from a URL.ValidatorResources(URL[] urls) Create a ValidatorResources object from several URL. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddConstant(String name, String value) Add a global constant to the resource.voidaddFormSet(FormSet fs) Add aFormSetto thisValidatorResourcesobject.voidAdd aValidatorActionto the resource.protected StringBuilds a key to store theFormSetunder based on it's language, country, and variant values.protected Map<String,ValidatorAction> Returns a Map of String ValidatorAction names to their ValidatorAction.Returns a Map of String constant names to their String values.Gets aFormbased on the name of the form and theLocalethat most closely matches theLocalepassed in.Gets aFormbased on the name of the form and theLocalethat most closely matches theLocalepassed in.Returns a Map of String locale keys to Lists of their FormSets.getValidatorAction(String key) Gets aValidatorActionbased on it's name.Gets an unmodifiableMapof theValidatorActions.voidprocess()Process theValidatorResourcesobject.
-
Field Details
-
defaultLocale
The default locale on our server. -
hFormSets
Deprecated.Subclasses should use getFormSets() instead.MapofFormSets stored under aLocalekey (expressed as a String). -
hConstants
Deprecated.Subclasses should use getConstants() instead.Mapof global constant values with the name of the constant as the key. -
hActions
Deprecated.Subclasses should use getActions() instead.MapofValidatorActions with the name of theValidatorActionas the key. -
defaultFormSet
This is the defaultFormSet(without locale). (We probably don't need the defaultLocale anymore.)
-
-
Constructor Details
-
ValidatorResources
public ValidatorResources()Create an empty ValidatorResources object. -
ValidatorResources
Create a ValidatorResources object from an InputStream.- Parameters:
in- InputStream to a validation.xml configuration file. It's the client's responsibility to close this stream.- Throws:
SAXException- if the validation XML files are not valid or well formed.IOException- if an I/O error occurs processing the XML files- Since:
- 1.1
-
ValidatorResources
Create a ValidatorResources object from an InputStream.- Parameters:
streams- An array of InputStreams to several validation.xml configuration files that will be read in order and merged into this object. It's the client's responsibility to close these streams.- Throws:
SAXException- if the validation XML files are not valid or well formed.IOException- if an I/O error occurs processing the XML files- Since:
- 1.1
-
ValidatorResources
Create a ValidatorResources object from an uri- Parameters:
uri- The location of a validation.xml configuration file.- Throws:
SAXException- if the validation XML files are not valid or well formed.IOException- if an I/O error occurs processing the XML files- Since:
- 1.2
-
ValidatorResources
Create a ValidatorResources object from several uris- Parameters:
uris- An array of uris to several validation.xml configuration files that will be read in order and merged into this object.- Throws:
SAXException- if the validation XML files are not valid or well formed.IOException- if an I/O error occurs processing the XML files- Since:
- 1.2
-
ValidatorResources
Create a ValidatorResources object from a URL.- Parameters:
url- The URL for the validation.xml configuration file that will be read into this object.- Throws:
SAXException- if the validation XML file are not valid or well formed.IOException- if an I/O error occurs processing the XML files- Since:
- 1.3.1
-
ValidatorResources
Create a ValidatorResources object from several URL.- Parameters:
urls- An array of URL to several validation.xml configuration files that will be read in order and merged into this object.- Throws:
SAXException- if the validation XML files are not valid or well formed.IOException- if an I/O error occurs processing the XML files- Since:
- 1.3.1
-
-
Method Details
-
addConstant
Add a global constant to the resource.- Parameters:
name- The constant name.value- The constant value.
-
addFormSet
Add aFormSetto thisValidatorResourcesobject. It will be associated with theLocaleof theFormSet.- Parameters:
fs- The form set to add.- Since:
- 1.1
-
addValidatorAction
Add aValidatorActionto the resource. It also creates an instance of the class based on theValidatorActions class name and retrieves theMethodinstance and sets them in theValidatorAction.- Parameters:
va- The validator action.
-
buildKey
Builds a key to store theFormSetunder based on it's language, country, and variant values.- Parameters:
fs- The Form Set.- Returns:
- generated key for a formset.
-
getActions
Returns a Map of String ValidatorAction names to their ValidatorAction.- Returns:
- Map of Validator Actions
- Since:
- 1.2.0
-
getConstants
Returns a Map of String constant names to their String values.- Returns:
- Map of Constants
- Since:
- 1.2.0
-
getForm
Gets a
Formbased on the name of the form and theLocalethat most closely matches theLocalepassed in. The order ofLocalematching is:- language + country + variant
- language + country
- language
- default locale
- Parameters:
locale- The Locale.formKey- The key for the Form.- Returns:
- The validator Form.
- Since:
- 1.1
-
getForm
Gets a
Formbased on the name of the form and theLocalethat most closely matches theLocalepassed in. The order ofLocalematching is:- language + country + variant
- language + country
- language
- default locale
- Parameters:
language- The locale's language.country- The locale's country.variant- The locale's language variant.formKey- The key for the Form.- Returns:
- The validator Form.
- Since:
- 1.1
-
getFormSets
Returns a Map of String locale keys to Lists of their FormSets.- Returns:
- Map of Form sets
- Since:
- 1.2.0
-
getValidatorAction
Gets aValidatorActionbased on it's name.- Parameters:
key- The validator action key.- Returns:
- The validator action.
-
getValidatorActions
Gets an unmodifiableMapof theValidatorActions.- Returns:
- Map of validator actions.
-
process
Process theValidatorResourcesobject. Currently sets theFastHashMaps 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.
-