org.apache.struts.action

Class DynaActionForm

Implemented Interfaces:
DynaBean, Serializable
Known Direct Subclasses:
DynaValidatorForm

public class DynaActionForm
extends ActionForm
implements DynaBean

Specialized subclass of ActionForm that allows the creation of form beans with dynamic sets of properties, without requiring the developer to create a Java class for each type of form bean.

USAGE NOTE - Since Struts 1.1, the reset method no longer initializes property values to those specified in <form-property> elements in the Struts module configuration file. If you wish to utilize that behavior, the simplest solution is to subclass DynaActionForm and call the initialize method inside it.

Version:
$Rev: 168012 $ $Date: 2005-05-03 23:39:10 +0100 (Tue, 03 May 2005) $
Since:
Struts 1.1

Field Summary

protected DynaActionFormClass
dynaClass
The DynaActionFormClass with which we are associated.
protected HashMap
dynaValues
The set of property values for this DynaActionForm, keyed by property name.

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Method Summary

boolean
contains(String name, String key)
Indicates if the specified mapped property contain a value for the specified key value.
Object
get(String name)
Return the value of a simple property with the specified name.
Object
get(String name, String key)
Return the value of a mapped property with the specified name, or null if there is no value for the specified key.
Object
get(String name, int index)
Return the value of an indexed property with the specified name.
DynaClass
getDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.
protected DynaProperty
getDynaProperty(String name)
Return the property descriptor for the specified property name.
Map
getMap()
Returns the Map containing the property values.
String
getString(String name)
Return the value of a String property with the specified name.
String[]
getStrings(String name)
Return the value of a String[] property with the specified name.
void
initialize(ActionMapping mapping)
Initialize all bean properties to their initial values, as specified in the FormPropertyConfig elements associated with the definition of this DynaActionForm.
void
initialize(FormBeanConfig config)
protected boolean
isDynaAssignable(Class dest, Class source)
Indicates if an object of the source class is assignable to the destination class.
void
remove(String name, String key)
Remove any existing value for the specified key on the specified mapped property.
void
reset(ActionMapping mapping, HttpServletRequest request)
Reset bean properties to their default state, as needed.
void
reset(ActionMapping mapping, ServletRequest request)
Reset bean properties to their default state, as needed.
void
set(String name, Object value)
Set the value of a simple property with the specified name.
void
set(String name, String key, Object value)
Set the value of a mapped property with the specified name.
void
set(String name, int index, Object value)
Set the value of an indexed property with the specified name.
(package private) void
setDynaActionFormClass(DynaActionFormClass dynaClass)
Set the DynaActionFormClass instance with which we are associated.
String
toString()
Render a String representation of this object.

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate

Field Details

dynaClass

protected DynaActionFormClass dynaClass
The DynaActionFormClass with which we are associated.

dynaValues

protected HashMap dynaValues
The set of property values for this DynaActionForm, keyed by property name.

Method Details

contains

public boolean contains(String name,
                        String key)
Indicates if the specified mapped property contain a value for the specified key value.
Parameters:
name - Name of the property to check
key - Name of the key to check

get

public Object get(String name)
Return the value of a simple property with the specified name.
Parameters:
name - Name of the property whose value is to be retrieved

get

public Object get(String name,
                  String key)
Return the value of a mapped property with the specified name, or null if there is no value for the specified key.
Parameters:
name - Name of the property whose value is to be retrieved
key - Key of the value to be retrieved

get

public Object get(String name,
                  int index)
Return the value of an indexed property with the specified name.
Parameters:
name - Name of the property whose value is to be retrieved
index - Index of the value to be retrieved

getDynaClass

public DynaClass getDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.

getDynaProperty

protected DynaProperty getDynaProperty(String name)
Return the property descriptor for the specified property name.
Parameters:
name - Name of the property for which to retrieve the descriptor

getMap

public Map getMap()
Returns the Map containing the property values. This is done mostly to facilitate accessing the DynaActionForm through JavaBeans accessors, in order to use the JavaServer Pages Standard Tag Library (JSTL).

For instance, the normal JSTL EL syntax for accessing an ActionForm would be something like this:

  ${formbean.prop}
The JSTL EL syntax for accessing a DynaActionForm looks something like this (because of the presence of this getMap() method):
  ${dynabean.map.prop}

getString

public String getString(String name)
Return the value of a String property with the specified name. This is equivalent to calling (String) dynaForm.get(name).
Parameters:
name - Name of the property whose value is to be retrieved
Since:
Struts 1.2

getStrings

public String[] getStrings(String name)
Return the value of a String[] property with the specified name. This is equivalent to calling (String[]) dynaForm.get(name).
Parameters:
name - Name of the property whose value is to be retrieved
Since:
Struts 1.2

initialize

public void initialize(ActionMapping mapping)
Initialize all bean properties to their initial values, as specified in the FormPropertyConfig elements associated with the definition of this DynaActionForm.
Parameters:
mapping - The mapping used to select this instance

initialize

public void initialize(FormBeanConfig config)

isDynaAssignable

protected boolean isDynaAssignable(Class dest,
                                   Class source)
Indicates if an object of the source class is assignable to the destination class.
Parameters:
dest - Destination class
source - Source class

remove

public void remove(String name,
                   String key)
Remove any existing value for the specified key on the specified mapped property.
Parameters:
name - Name of the property for which a value is to be removed
key - Key of the value to be removed

reset

public void reset(ActionMapping mapping,
                  HttpServletRequest request)
Reset bean properties to their default state, as needed. This method is called before the properties are repopulated by the controller.

The default implementation (since Struts 1.1) does nothing. Subclasses may override this method to reset bean properties to default values, or the initialize method may be used to initialize property values to those provided in the form property configuration information (which was the behavior of this method in some release candidates).

Overrides:
reset in interface ActionForm
Parameters:
mapping - The mapping used to select this instance
request - The servlet request we are processing

reset

public void reset(ActionMapping mapping,
                  ServletRequest request)
Reset bean properties to their default state, as needed. This method is called before the properties are repopulated by the controller.

The default implementation attempts to forward to the HTTP version of this method.

Overrides:
reset in interface ActionForm
Parameters:
mapping - The mapping used to select this instance
request - The servlet request we are processing

set

public void set(String name,
                Object value)
Set the value of a simple property with the specified name.
Parameters:
name - Name of the property whose value is to be set
value - Value to which this property is to be set

set

public void set(String name,
                String key,
                Object value)
Set the value of a mapped property with the specified name.
Parameters:
name - Name of the property whose value is to be set
key - Key of the property to be set
value - Value to which this property is to be set

set

public void set(String name,
                int index,
                Object value)
Set the value of an indexed property with the specified name.
Parameters:
name - Name of the property whose value is to be set
index - Index of the property to be set
value - Value to which this property is to be set

setDynaActionFormClass

(package private)  void setDynaActionFormClass(DynaActionFormClass dynaClass)
Set the DynaActionFormClass instance with which we are associated.
Parameters:
dynaClass - The DynaActionFormClass instance for this bean

toString

public String toString()
Render a String representation of this object.

Copyright B) 2000-2007 - The Apache Software Foundation