org.apache.cocoon.selection
Class RequestParameterSelector

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLogEnabled
      extended byorg.apache.cocoon.selection.AbstractSwitchSelector
          extended byorg.apache.cocoon.selection.RequestParameterSelector
All Implemented Interfaces:
Configurable, LogEnabled, Selector, SwitchSelector, ThreadSafe

public class RequestParameterSelector
extends AbstractSwitchSelector
implements Configurable, ThreadSafe

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

Global and local configuration

parameter-nameName of the request parameter whose value to match against

Version:
CVS $Id: RequestParameterSelector.java 30941 2004-07-29 19:56:58Z vgritsenko $
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)
          Selectors test pattern against some objects in a Map model and signals 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 class: AbstractSwitchSelector
Method to create a selector context.

Specified by:
getSelectorContext in interface SwitchSelector
Specified by:
getSelectorContext in class AbstractSwitchSelector
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 class: AbstractSwitchSelector
Selectors test pattern against some objects in a Map model and signals success with the returned boolean value

Specified by:
select in interface SwitchSelector
Specified by:
select in class AbstractSwitchSelector
Parameters:
expression - The expression to test.
Returns:
boolean Signals successful test.


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.