org.apache.cocoon.selection
Class RequestParameterSelector

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.selection.AbstractSwitchSelector
          org.apache.cocoon.selection.RequestParameterSelector

All Implemented Interfaces:

Component, Configurable, LogEnabled, ThreadSafe, Selector, SwitchSelector

Direct Known Subclasses:

RequestSelector

public class RequestParameterSelector
extends AbstractSwitchSelector
implements Configurable

A Selector that matches a string against a configurable request parameter's value.

Global and local configuration

parameter-name

Name of the request parameter whose value to match against

Version:

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

Author:

Christian Haul, Sylvain Wallez, Vadim Gritsenko, Marcus Crafter

Field Summary

protected String

defaultName

Fields inherited from interface org.apache.cocoon.selection.SwitchSelector

ROLE

Constructor Summary

RequestParameterSelector()

Method Summary

void	configure(Configuration config)
Object	getSelectorContext(Map objectModel, Parameters parameters) Method to create a selector context.
boolean	select(String expression, Object selectorContext) Switch Selectors test patterns against a context object and signal success with the returned boolean value

Methods inherited from class org.apache.cocoon.selection.AbstractSwitchSelector

select

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

defaultName

protected String defaultName

Constructor Detail

RequestParameterSelector

public RequestParameterSelector()

Method Detail

configure

public void configure(Configuration config)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getSelectorContext

public Object getSelectorContext(Map objectModel,
                                 Parameters parameters)

Description copied from interface: SwitchSelector

Method to create a selector context.

Specified by:

getSelectorContext in interface SwitchSelector

Parameters:

objectModel - The Map containing object of the calling environment which may be used to select values to test the expression.

parameters - The sitemap parameters, as specified by <parameter/> tags.

Returns:

Selector context

select

public boolean select(String expression,
                      Object selectorContext)

Description copied from interface: SwitchSelector

Switch Selectors test patterns against a context object and signal success with the returned boolean value

Specified by:

select in interface SwitchSelector

Parameters:

expression - The expression to test.

selectorContext - The context this test should be performed in.

Returns:

true if the test was successful.