org.apache.cocoon.matching
Class RequestParameterMatcher

java.lang.Object
  |
  +--org.apache.cocoon.matching.RequestParameterMatcher

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, Matcher, org.apache.avalon.framework.thread.ThreadSafe

Direct Known Subclasses:

RequestParamMatcher

public class RequestParameterMatcher

extends java.lang.Object

implements Matcher, org.apache.avalon.framework.thread.ThreadSafe

This class allows for matching based on a request parameter. If the specified request parameter exists, its value is retrieved for later sitemap substitution.

Example:

 <map:match type="request" pattern="dest">
     <map:redirect-to uri="{1}"/>
 </map:match>
 

Version:

CVS $Id: RequestParameterMatcher.java,v 1.5.2.2 2002/10/03 04:40:44 vgritsenko Exp $

Author:

Marcus Crafter, Vadim Gritsenko

Fields inherited from interface org.apache.cocoon.matching.Matcher

ROLE

Constructor Summary

RequestParameterMatcher()

Method Summary

java.util.Map

match(java.lang.String pattern, java.util.Map objectModel, org.apache.avalon.framework.parameters.Parameters parameters) Match method to see if the request parameter exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestParameterMatcher

public RequestParameterMatcher()

Method Detail

match

public java.util.Map match(java.lang.String pattern,
                           java.util.Map objectModel,
                           org.apache.avalon.framework.parameters.Parameters parameters)

Match method to see if the request parameter exists. If it does have a value the parameter is added to the array list for later sitemap substitution.

Specified by:

match in interface Matcher

Parameters:

pattern - name of request parameter to find

objectModel - environment passed through via cocoon

Returns:

null or map containing value of request parameter 'pattern'