org.apache.cocoon.acting
Class SetterAction

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.acting.AbstractAction
          extended byorg.apache.cocoon.acting.SetterAction
All Implemented Interfaces:
org.apache.cocoon.acting.Action, Parameterizable, ThreadSafe

public class SetterAction
extends org.apache.cocoon.acting.AbstractAction
implements Parameterizable, ThreadSafe

This action can be used to set information in either the object model, the request or the session.

All parameters set for this action are set in the according location whereas the parameter name is the key and the value of the parameter will be set as a string value for this key.

Version:
$Id: SetterAction.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
protected  int mode
           
static int MODE_OBJECT_MODEL
           
static int MODE_REQUEST_ATTR
           
static int MODE_SESSION_ATTR
           
static String MODEDEF_OBJECT_MODEL
           
static String MODEDEF_REQUEST_ATTR
           
static String MODEDEF_SESSION_ATTR
           
 
Fields inherited from class org.apache.cocoon.acting.AbstractAction
EMPTY_MAP
 
Fields inherited from interface org.apache.cocoon.acting.Action
ROLE
 
Constructor Summary
SetterAction()
           
 
Method Summary
 Map act(org.apache.cocoon.environment.Redirector redirector, org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String source, Parameters parameters)
           
 void parameterize(Parameters params)
           
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODE_OBJECT_MODEL

public static final int MODE_OBJECT_MODEL
See Also:
Constant Field Values

MODE_REQUEST_ATTR

public static final int MODE_REQUEST_ATTR
See Also:
Constant Field Values

MODE_SESSION_ATTR

public static final int MODE_SESSION_ATTR
See Also:
Constant Field Values

MODEDEF_OBJECT_MODEL

public static final String MODEDEF_OBJECT_MODEL
See Also:
Constant Field Values

MODEDEF_REQUEST_ATTR

public static final String MODEDEF_REQUEST_ATTR
See Also:
Constant Field Values

MODEDEF_SESSION_ATTR

public static final String MODEDEF_SESSION_ATTR
See Also:
Constant Field Values

mode

protected int mode
Constructor Detail

SetterAction

public SetterAction()
Method Detail

parameterize

public void parameterize(Parameters params)
                  throws ParameterException
Specified by:
parameterize in interface Parameterizable
Throws:
ParameterException
See Also:
Parameterizable.parameterize(org.apache.avalon.framework.parameters.Parameters)

act

public Map act(org.apache.cocoon.environment.Redirector redirector,
               org.apache.cocoon.environment.SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception
Specified by:
act in interface org.apache.cocoon.acting.Action
Throws:
Exception
See Also:
Action.act(org.apache.cocoon.environment.Redirector, org.apache.cocoon.environment.SourceResolver, java.util.Map, java.lang.String, org.apache.avalon.framework.parameters.Parameters)


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.