org.apache.cocoon.components.modules.output
Class RequestAttributeOutputModule

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLogEnabled
        |
        +--org.apache.cocoon.components.modules.output.AbstractOutputModule
              |
              +--org.apache.cocoon.components.modules.output.RequestAttributeOutputModule

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.logger.LogEnabled, OutputModule

public class RequestAttributeOutputModule

extends AbstractOutputModule

implements OutputModule

Abstraction layer to encapsulate different output destinations. Configuration option <key-prefix> defaults to "org.apache.cocoon.components.modules.output.OutputModule"+":"

Version:

CVS $Id: RequestAttributeOutputModule.java,v 1.4 2002/08/09 08:32:10 haul Exp $

Author:

Christian Haul

Fields inherited from class org.apache.cocoon.components.modules.output.AbstractOutputModule

settings

Fields inherited from interface org.apache.cocoon.components.modules.output.OutputModule

ROLE

Constructor Summary

RequestAttributeOutputModule()

Method Summary

void	commit(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel) Signal that the database transaction completed successfully.
void	rollback(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel, java.lang.Exception e) If a database transaction needs to rollback, this is called to inform the further processing logic about this fact.
void	setAttribute(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel, java.lang.String name, java.lang.Object value) communicate an attribute value to further processing logic.

Methods inherited from class org.apache.cocoon.components.modules.output.AbstractOutputModule

configure, dispose

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

Constructor Detail

RequestAttributeOutputModule

public RequestAttributeOutputModule()

Method Detail

setAttribute

public void setAttribute(org.apache.avalon.framework.configuration.Configuration modeConf,
                         java.util.Map objectModel,
                         java.lang.String name,
                         java.lang.Object value)

communicate an attribute value to further processing logic.

Specified by:

setAttribute in interface OutputModule

Parameters:

modeConf - column's mode configuration from resource description. This argument is optional.

request - The request object

name - The attribute's label, consisting of "table.column" or "table.column[index]" in case of multiple attributes of the same spec.

value - The attriute's value.

rollback

public void rollback(org.apache.avalon.framework.configuration.Configuration modeConf,
                     java.util.Map objectModel,
                     java.lang.Exception e)

If a database transaction needs to rollback, this is called to inform the further processing logic about this fact. All already set attribute values are invalidated. This is difficult because only the request object can be used to synchronize this and build some kind of transaction object. Beaware that sending your data straight to some beans or other entities could result in data corruption!

Specified by:

rollback in interface OutputModule

commit

public void commit(org.apache.avalon.framework.configuration.Configuration modeConf,
                   java.util.Map objectModel)

Signal that the database transaction completed successfully. See notes on @link{rollback}.

Specified by:

commit in interface OutputModule