This project has retired. For details please refer to its Attic page.

org.apache.cocoon.acting
Class DatabaseSelectAction

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.acting.AbstractAction
          org.apache.cocoon.acting.AbstractConfigurableAction
              org.apache.cocoon.acting.ConfigurableServiceableAction
                  org.apache.cocoon.acting.AbstractComplementaryConfigurableAction
                      org.apache.cocoon.acting.AbstractDatabaseAction
                          org.apache.cocoon.acting.DatabaseSelectAction

All Implemented Interfaces:

Disposable, Component, Configurable, LogEnabled, Serviceable, ThreadSafe, Action

public class DatabaseSelectAction
extends AbstractDatabaseAction
implements ThreadSafe

Select a record from a database. If request parameters are present, their values are used to populate request attributes. Otherwise, values from database are used.

Version:

CVS $Id: DatabaseSelectAction.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Berin Loritsch, Vadim Gritsenko

Field Summary

Fields inherited from class org.apache.cocoon.acting.AbstractDatabaseAction

dbselector, files, typeConstants

Fields inherited from class org.apache.cocoon.acting.ConfigurableServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractConfigurableAction

settings

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

DatabaseSelectAction()

Method Summary

Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters param) Select a record from the database.
protected String	getSelectQuery(Configuration conf) Get the String representation of the PreparedStatement.

Methods inherited from class org.apache.cocoon.acting.AbstractDatabaseAction

buildList, buildList, dispose, getColumn, getDataSource, getRequestAttribute, isLargeObject, service, setColumn, setColumn, setColumn, setColumn, setRequestAttribute

Methods inherited from class org.apache.cocoon.acting.AbstractComplementaryConfigurableAction

getConfiguration, getConfiguration, getConfiguration

Methods inherited from class org.apache.cocoon.acting.AbstractConfigurableAction

configure

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

DatabaseSelectAction

public DatabaseSelectAction()

Method Detail

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters param)
        throws Exception

Select a record from the database. This action assumes that the file referenced by the "descriptor" parameter conforms to the AbstractDatabaseAction specifications.

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

param - 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

getSelectQuery

protected String getSelectQuery(Configuration conf)
                         throws ConfigurationException

Get the String representation of the PreparedStatement. This is mapped to the Configuration object itself, so if it doesn't exist, it will be created.

Throws:

ConfigurationException