|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
Method Summary | |
void |
defineElement(FormElement element)
This defines an element to be mapped by this form, using the key from the FormElement. |
void |
defineElement(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(String key)
Return true if an element exists (not null) |
Boolean |
getBooleanVal(String key)
Get an Boolean value from the map |
Boolean |
getBooleanVal(String key,
Boolean dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
Date |
getDateVal(String key)
Get an Date value from the map |
Date |
getDateVal(String key,
Date dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
Double |
getDoubleVal(String key)
Get an Double value from the map |
Double |
getDoubleVal(String key,
Double dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
FormElement |
getElement(String key)
Get an element by key |
Map |
getElements()
return a map with containing all the elements in this form map |
Map |
getElementVals()
return a map with containing the values for all the elements in this form map |
Float |
getFloatVal(String key)
Get an Float value from the map |
Float |
getFloatVal(String key,
Float dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
Integer |
getIntegerVal(String key)
Get an Integer value from the map |
Integer |
getIntegerVal(String key,
Integer dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
Long |
getLongVal(String key)
Get an Long value from the map |
Long |
getLongVal(String key,
Long dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
Short |
getShortVal(String key)
Get an Short value from the map |
Short |
getShortVal(String key,
Short dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
String |
getStringVal(String key)
Get a String value from the map |
String |
getStringVal(String key,
String dflt)
Get the value for a given key, defaulting accordingly if the value is null. |
Object |
getVal(String key)
Get the value for a given key. |
Object[] |
getVals(String key)
Get an array of values for a given key. |
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,
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,
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,
String prefix,
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,
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,
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,
String prefix,
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(String key,
Object origVal)
This allows you to map a single value (as opposed to passing in a whole statemap or request). |
FormElement |
mapElement(String key,
Object origVal,
Locale loc)
This allows you to map a single value (as opposed to passing in a whole statemap or request). |
void |
setVal(String key,
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 interface org.enhydra.barracuda.plankton.data.StateMap |
clearState, getState, getStateKeys, getStateValues, putState, removeState |
Method Detail |
public void defineElement(FormElement element)
element
- a FormElement to be mapped by this formpublic void defineElement(String key, FormElement element)
key
- the key which uniquely identifies this FormElementelement
- a FormElement to be mapped by this formpublic void defineValidator(FormValidator validator)
validator
- a form validator to be applied to the entire formpublic FormMap map(javax.servlet.ServletRequest req)
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, Locale loc)
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(StateMap map)
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, Locale loc)
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, String prefix)
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, String prefix, Locale loc)
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 FormMap map(javax.servlet.ServletRequest req, String prefix, Locale loc)
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(javax.servlet.ServletRequest req, String prefix)
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 FormElement mapElement(String key, Object origVal)
key
- the name of the element we wish to map toorigVal
- the original value to be mapped
public FormElement mapElement(String key, Object origVal, Locale loc)
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
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
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
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 boolean exists(String key)
key
- the key which uniquely identifies this FormElement
public FormElement getElement(String key)
key
- the key which uniquely identifies this FormElement
public Map getElements()
public Map getElementVals()
public void setVal(String key, Object val)
key
- the keyval
- the value for the keypublic Object getVal(String key)
key
- the key which uniquely identifies this FormElement
public Object[] getVals(String key)
key
- the key which uniquely identifies this FormElement
public String getStringVal(String key)
key
- the form element key
public String getStringVal(String key, String dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public Boolean getBooleanVal(String key)
key
- the form element key
public Boolean getBooleanVal(String key, Boolean dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public Integer getIntegerVal(String key)
key
- the form element key
public Integer getIntegerVal(String key, Integer dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public Date getDateVal(String key)
key
- the form element key
public Date getDateVal(String key, Date dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public Long getLongVal(String key)
key
- the form element key
public Long getLongVal(String key, Long dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public Short getShortVal(String key)
key
- the form element key
public Short getShortVal(String key, Short dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public Double getDoubleVal(String key)
key
- the form element key
public Double getDoubleVal(String key, Double dflt)
key
- the key which uniquely identifies this FormElementdflt
- the default value to be used if the underlying value is null
public Float getFloatVal(String key)
key
- the form element key
public Float getFloatVal(String key, 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 |