org.apache.cocoon.acting
Class SetterAction

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
          org.apache.cocoon.acting.SetterAction

All Implemented Interfaces:

Component, LogEnabled, Parameterizable, ThreadSafe, Action

public class SetterAction
extends 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:

SVN $Id: SetterAction.html 1304258 2012-03-23 10:09:27Z 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(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters) Controls the processing against some values of the Dictionary objectModel and returns a Map object with values used in subsequent sitemap substitution patterns.
void	parameterize(Parameters params)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

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(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception

Description copied from interface: Action

Controls the processing against some values of the Dictionary objectModel and returns a Map object with values used in subsequent sitemap substitution patterns. NOTE: This interface is designed so that implentations can be ThreadSafe. When an action is ThreadSafe, only one instance serves all requests : this reduces memory usage and avoids pooling.

Specified by:

act in interface Action

resolver - The SourceResolver in charge

objectModel - The Map with object of the calling environment which can be used to select values this controller may need (ie Request, Response).

source - A source String to the Action

parameters - The Parameters for this invocation

Returns:

Map The returned Map object with sitemap substitution values which can be used in subsequent elements attributes like src= using a xpath like expression: src="mydir/{myval}/foo" If the return value is null the processing inside the element of the sitemap will be skipped.

Throws:

Exception - Indicates something is totally wrong

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)