|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.barracuda.core.forms.DefaultFormMap
This class provides the default implementation of a FormMap.
A FormMap is used to provide a virtual representation of a form. It can contain any number of unique FormElements, and it can also be associated with FormValidators. The primary function of a form map is to:
Field Summary | |
protected static java.util.Locale |
defaultLoc
|
protected java.util.Map |
elements
|
protected static org.apache.log4j.Logger |
localLogger
|
protected StateMap |
statemap
|
protected java.util.List |
validators
|
Constructor Summary | |
DefaultFormMap()
|
Method Summary | |
void |
defineElement(FormElement element)
This defines an element to be mapped by this form, using the key from the FormElement. |
void |
defineElement(java.lang.String key,
FormElement element)
This defines an element to be mapped by this form. |
void |
defineValidator(FormValidator validator)
This defines a validator for the entire form. |
boolean |
exists(java.lang.String key)
Return true if an element exists and its value is not null |
java.lang.Boolean |
getBooleanVal(java.lang.String key)
Get an Boolean value from the map |
java.lang.Boolean |
getBooleanVal(java.lang.String key,
java.lang.Boolean dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
java.util.Date |
getDateVal(java.lang.String key)
Get an Date value from the map |
java.lang.Double |
getDoubleVal(java.lang.String key)
Get an Double value from the map |
java.lang.Double |
getDoubleVal(java.lang.String key,
java.lang.Double dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
FormElement |
getElement(java.lang.String key)
Get an element by key |
java.util.Map |
getElements()
return a map with containing all the elements in this form map |
java.lang.Float |
getFloatVal(java.lang.String key)
Get an Float value from the map |
java.lang.Float |
getFloatVal(java.lang.String key,
java.lang.Float dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
java.lang.Integer |
getIntegerVal(java.lang.String key)
Get an Integer value from the map |
java.lang.Integer |
getIntegerVal(java.lang.String key,
java.lang.Integer dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
java.lang.Long |
getLongVal(java.lang.String key)
Get an Long value from the map |
java.lang.Long |
getLongVal(java.lang.String key,
java.lang.Long dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
java.lang.Short |
getShortVal(java.lang.String key)
Get an Short value from the map |
java.lang.Short |
getShortVal(java.lang.String key,
java.lang.Short dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
java.lang.Object |
getState(java.lang.Object key)
get a property in this StateMap |
java.util.List |
getStateKeys()
get a list of the keys for this StateMap |
java.util.Map |
getStateValues()
get a copy of the underlying Map |
java.lang.String |
getStringVal(java.lang.String key)
Get a String value from the map |
java.util.Date |
getStringVal(java.lang.String key,
java.util.Date dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
java.lang.String |
getStringVal(java.lang.String key,
java.lang.String dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
java.lang.Object |
getVal(java.lang.String key)
Get the value for a given key. |
java.util.Map |
getVals()
Get the a map of all the values that back this form map |
FormMap |
map(javax.servlet.ServletRequest req)
This is where we actually take an incoming form (in the form of a ServletRequest) and map it using the definitions supplied by all the FormElements. |
FormMap |
map(javax.servlet.ServletRequest req,
java.util.Locale loc)
This is where we actually take an incoming form (in the form of a ServletRequest) and map it using the definitions supplied by all the FormElements. |
FormMap |
map(javax.servlet.ServletRequest req,
java.lang.String prefix)
This is where we actually take an incoming form (in the form of a ServletRequest) and map it using the definitions supplied by all the FormElements. |
FormMap |
map(javax.servlet.ServletRequest req,
java.lang.String prefix,
java.util.Locale loc)
This is where we actually take an incoming form (in the form of a ServletRequest) and map it using the definitions supplied by all the FormElements. |
FormMap |
map(StateMap map)
This is where we actually take an incoming form (in the form of a StateMap) and map it using the definitions supplied by all the FormElements. |
FormMap |
map(StateMap map,
java.util.Locale loc)
This is where we actually take an incoming form (in the form of a StateMap) and map it using the definitions supplied by all the FormElements. |
FormMap |
map(StateMap map,
java.lang.String prefix)
This is where we actually take an incoming form (in the form of a StateMap) and map it using the definitions supplied by all the FormElements. |
FormMap |
map(StateMap map,
java.lang.String prefix,
java.util.Locale loc)
This is where we actually take an incoming form (in the form of a StateMap) and map it using the definitions supplied by all the FormElements. |
FormElement |
mapElement(java.lang.String key,
java.lang.Object origVal)
This allows you to map a single value (as opposed to passing in a whole statemap or request). |
FormElement |
mapElement(java.lang.String key,
java.lang.Object origVal,
java.util.Locale loc)
This allows you to map a single value (as opposed to passing in a whole statemap or request). |
void |
putState(java.lang.Object key,
java.lang.Object val)
set a property in this StateMap |
java.lang.Object |
removeState(java.lang.Object key)
remove a property in this StateMap |
void |
setVal(java.lang.String key,
java.lang.Object val)
Manually set the value of an element. |
FormMap |
validate(boolean deferExceptions)
Validate the entire form (both form level and elements). |
FormMap |
validateElements(boolean deferExceptions)
Validate just the elements (not the form) |
FormMap |
validateForm(boolean deferExceptions)
Validate just the form (not the individual elements) |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static org.apache.log4j.Logger localLogger
protected java.util.Map elements
protected java.util.List validators
protected StateMap statemap
protected static final java.util.Locale defaultLoc
Constructor Detail |
public DefaultFormMap()
Method Detail |
public void defineElement(FormElement element)
defineElement
in interface FormMap
element
- a FormElement to be mapped by this formpublic void defineElement(java.lang.String key, FormElement element)
defineElement
in interface FormMap
key
- the key which uniquely identifies this FormElementelement
- a FormElement to be mapped by this formpublic void defineValidator(FormValidator validator)
defineValidator
in interface FormMap
validator
- a form validator to be applied to the entire formpublic FormMap map(javax.servlet.ServletRequest req)
map
in interface FormMap
req
- the ServletRequest to map paramters from based on
all defined FormElements
MappingException
- if for some reason the value cannot
be mapped successfullypublic FormMap map(javax.servlet.ServletRequest req, java.util.Locale loc)
map
in interface FormMap
req
- the ServletRequest to map paramters from based on
all defined FormElementsloc
- the locale to use when parsing Dates and other locale dependend
values.
MappingException
- if for some reason the value cannot
be mapped successfullypublic FormMap map(javax.servlet.ServletRequest req, java.lang.String prefix)
map
in interface FormMap
req
- the ServletRequest to map paramters from based on
all defined FormElementsprefix
- the prefix to use when mapping parameters
MappingException
- if for some reason the value cannot
be mapped successfullypublic FormMap map(javax.servlet.ServletRequest req, java.lang.String prefix, java.util.Locale loc)
map
in interface FormMap
req
- the ServletRequest to map paramters from based on
all defined FormElementsprefix
- the prefix to use when mapping parametersloc
- the locale to use when parsing Dates and other locale dependend
values.
MappingException
- if for some reason the value cannot
be mapped successfullypublic FormMap map(StateMap map)
map
in interface FormMap
map
- the StateMap to map properties from based on
all defined FormElements
MappingException
- if for some reason the value cannot
be mapped successfullypublic FormMap map(StateMap map, java.lang.String prefix)
map
in interface FormMap
map
- the StateMap to map properties from based on
all defined FormElementsprefix
- the prefix to use when mapping parameters
MappingException
- if for some reason the value cannot
be mapped successfullypublic FormMap map(StateMap map, java.util.Locale loc)
map
in interface FormMap
map
- the StateMap to map properties from based on
all defined FormElementsloc
- the locale to use when parsing Dates and other locale dependend
values.
MappingException
- if for some reason the value cannot
be mapped successfullypublic FormMap map(StateMap map, java.lang.String prefix, java.util.Locale loc)
map
in interface FormMap
map
- the StateMap to map properties from based on
all defined FormElementsprefix
- the prefix to use when mapping parametersloc
- the locale to use when parsing Dates and other locale dependend
values.
MappingException
- if for some reason the value cannot
be mapped successfullypublic FormElement mapElement(java.lang.String key, java.lang.Object origVal)
mapElement
in interface FormMap
key
- the name of the element we wish to map toorigVal
- the original value to be mapped
public FormElement mapElement(java.lang.String key, java.lang.Object origVal, java.util.Locale loc)
mapElement
in interface FormMap
key
- the name of the element we wish to map toorigVal
- the original value to be mappedloc
- the locale to use when parsing Dates and other locale dependant values.
public FormMap validate(boolean deferExceptions) throws ValidationException
validate
in interface FormMap
deferExceptions
- do we want to deferValidation exceptions
and attempt to validate all elements so that we can process
all the exceptions at once
ValidationException
- if the form (or any element within it)
is invalidpublic FormMap validateElements(boolean deferExceptions) throws ValidationException
validateElements
in interface FormMap
deferExceptions
- do we want to deferValidation exceptions
and attempt to validate all elements so that we can process
all the exceptions at once
ValidationException
- if the form (or any element within it)
is invalidpublic FormMap validateForm(boolean deferExceptions) throws ValidationException
validateForm
in interface FormMap
deferExceptions
- do we want to deferValidation exceptions
and attempt to validate all elements so that we can process
all the exceptions at once
ValidationException
- if the form (or any element within it)
is invalidpublic void putState(java.lang.Object key, java.lang.Object val)
putState
in interface StateMap
key
- the state key objectval
- the state value objectpublic java.lang.Object getState(java.lang.Object key)
getState
in interface StateMap
key
- the state key object
public java.lang.Object removeState(java.lang.Object key)
removeState
in interface StateMap
key
- the key object
public java.util.List getStateKeys()
getStateKeys
in interface StateMap
public java.util.Map getStateValues()
getStateValues
in interface StateMap
public boolean exists(java.lang.String key)
exists
in interface FormMap
key
- the key which uniquely identifies this FormElement
public FormElement getElement(java.lang.String key)
getElement
in interface FormMap
key
- the key which uniquely identifies this FormElement
public java.util.Map getElements()
getElements
in interface FormMap
public void setVal(java.lang.String key, java.lang.Object val)
setVal
in interface FormMap
key
- the keyval
- the value for the keypublic java.lang.Object getVal(java.lang.String key)
getVal
in interface FormMap
key
- the key which uniquely identifies this FormElement
public java.util.Map getVals()
public java.lang.String getStringVal(java.lang.String key)
key
- the form element key
public java.lang.String getStringVal(java.lang.String key, java.lang.String dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public java.lang.Boolean getBooleanVal(java.lang.String key)
key
- the form element key
public java.lang.Boolean getBooleanVal(java.lang.String key, java.lang.Boolean dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public java.lang.Integer getIntegerVal(java.lang.String key)
key
- the form element key
public java.lang.Integer getIntegerVal(java.lang.String key, java.lang.Integer dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public java.util.Date getDateVal(java.lang.String key)
key
- the form element key
public java.util.Date getStringVal(java.lang.String key, java.util.Date dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public java.lang.Long getLongVal(java.lang.String key)
key
- the form element key
public java.lang.Long getLongVal(java.lang.String key, java.lang.Long dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public java.lang.Short getShortVal(java.lang.String key)
key
- the form element key
public java.lang.Short getShortVal(java.lang.String key, java.lang.Short dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public java.lang.Double getDoubleVal(java.lang.String key)
key
- the form element key
public java.lang.Double getDoubleVal(java.lang.String key, java.lang.Double dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public java.lang.Float getFloatVal(java.lang.String key)
key
- the form element key
public java.lang.Float getFloatVal(java.lang.String key, java.lang.Float dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |