|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.validator.ValidatorResources
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.
Field Summary | |
protected static java.util.Locale |
defaultLocale
The default locale on our server. |
protected org.apache.commons.collections.FastHashMap |
hActions
FastHashMap of ValidatorAction s 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 FormSet s stored under
a Locale key. |
protected static org.apache.commons.logging.Log |
log
Deprecated. Subclasses should use their own logging instance. |
Constructor Summary | |
ValidatorResources()
Create an empty ValidatorResources object. |
|
ValidatorResources(java.io.InputStream in)
Create a ValidatorResources object from an InputStream. |
|
ValidatorResources(java.io.InputStream[] streams)
Create a ValidatorResources object from an InputStream. |
Method Summary | |
void |
addConstant(Constant c)
Deprecated. Use addConstant(String, String) instead. |
void |
addConstant(java.lang.String name,
java.lang.String value)
Add a global constant to the resource. |
void |
addConstantParam(java.lang.String name,
java.lang.String value)
Deprecated. Use addConstant(String, String) instead. |
void |
addFormSet(FormSet fs)
Add a FormSet to this ValidatorResources
object. |
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)
Deprecated. Use getForm() instead. |
Form |
get(java.lang.String language,
java.lang.String country,
java.lang.String variant,
java.lang.Object formKey)
Deprecated. Use getForm() instead. |
protected Field |
getClosestLocaleField(FormSet fs,
java.lang.String formKey,
java.lang.String fieldKey)
Retrieves the closest matching Field based
on FormSet 's locale. |
Form |
getForm(java.util.Locale locale,
java.lang.String formKey)
Gets a Form based on the name of the form and the
Locale that most closely matches the Locale
passed in. |
Form |
getForm(java.lang.String language,
java.lang.String country,
java.lang.String variant,
java.lang.String formKey)
Gets a Form based on the name of the form and the
Locale that most closely matches the Locale
passed in. |
ValidatorAction |
getValidatorAction(java.lang.String key)
Get a ValidatorAction based on it's name. |
java.util.Map |
getValidatorActions()
Get an unmodifiable Map of the ValidatorAction s. |
void |
process()
Process the ValidatorResources object. |
void |
processForms()
Deprecated. This is an internal method that client classes need not call directly. |
void |
put(FormSet fs)
Deprecated. Use addFormSet() instead. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static org.apache.commons.logging.Log log
protected org.apache.commons.collections.FastHashMap hFormSets
FastHashMap
of FormSet
s stored under
a Locale
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 hActions
FastHashMap
of ValidatorAction
s with
the name of the ValidatorAction
as the key.
protected static java.util.Locale defaultLocale
Constructor Detail |
public ValidatorResources()
public ValidatorResources(java.io.InputStream in) throws java.io.IOException, org.xml.sax.SAXException
in
- InputStream to a validation.xml configuration file. It's the client's
responsibility to close this stream.
java.io.IOException
org.xml.sax.SAXException
- if the validation XML files are not valid or well
formed.public ValidatorResources(java.io.InputStream[] streams) throws java.io.IOException, org.xml.sax.SAXException
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.
java.io.IOException
org.xml.sax.SAXException
- if the validation XML files are not valid or well
formed.Method Detail |
public void put(FormSet fs)
FormSet
to this ValidatorResources
object. It will be associated with the Locale
of the
FormSet
.
public void addFormSet(FormSet fs)
FormSet
to this ValidatorResources
object. It will be associated with the Locale
of the
FormSet
.
public void addConstant(Constant c)
public void addConstantParam(java.lang.String name, java.lang.String value)
public void addConstant(java.lang.String name, java.lang.String value)
public void addValidatorAction(ValidatorAction va)
ValidatorAction
to the resource. It also creates an
instance of the class based on the ValidatorAction
s
classname and retrieves the Method
instance and sets them
in the ValidatorAction
.
public ValidatorAction getValidatorAction(java.lang.String key)
ValidatorAction
based on it's name.
public java.util.Map getValidatorActions()
Map
of the ValidatorAction
s.
protected java.lang.String buildKey(FormSet fs)
FormSet
under based on it's
language, country, and variant values.
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:
public Form getForm(java.util.Locale locale, java.lang.String 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:
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:
public Form getForm(java.lang.String language, java.lang.String country, java.lang.String variant, java.lang.String 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:
public void process()
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.
public void processForms()
Process the Form
objects. This clones the Field
s
that don't exist in a FormSet
compared to the default
FormSet
.
protected Field getClosestLocaleField(FormSet fs, java.lang.String formKey, java.lang.String fieldKey)
Field
based
on FormSet
's locale. This is used when
constructing a clone, field by field, of partial
FormSet
.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |