org.apache.cocoon.matching
Class RequestParameterMatcher

java.lang.Object
  org.apache.cocoon.matching.RequestParameterMatcher

All Implemented Interfaces:

Component, ThreadSafe, Matcher

Direct Known Subclasses:

RequestParamMatcher

public class RequestParameterMatcher
extends Object
implements Matcher, 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.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Marcus Crafter, Vadim Gritsenko

Field Summary

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

ROLE

Constructor Summary

RequestParameterMatcher()

Method Summary

Map	match(String pattern, Map objectModel, 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 Map match(String pattern,
                 Map objectModel,
                 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'