org.apache.cocoon.matching
Class AbstractWildcardMatcher

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.matching.AbstractWildcardMatcher
All Implemented Interfaces:
Component, LogEnabled, ThreadSafe, Matcher
Direct Known Subclasses:
CachingWildcardMatcher, WildcardHeaderMatcher, WildcardHostMatcher, WildcardMatcher, WildcardParameterMatcher, WildcardRequestAttributeMatcher, WildcardRequestParameterMatcher, WildcardSessionAttributeMatcher, WildcardURIMatcher

public abstract class AbstractWildcardMatcher
extends AbstractLogEnabled
implements Matcher, ThreadSafe

Base class for wildcard matchers

Version:
$Id: AbstractWildcardMatcher.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Sylvain Wallez

Field Summary
 
Fields inherited from interface org.apache.cocoon.matching.Matcher
ROLE
 
Constructor Summary
AbstractWildcardMatcher()
           
 
Method Summary
protected abstract  String getMatchString(Map objectModel, Parameters parameters)
          Get the string to test against the wildcard expression.
 Map match(String pattern, Map objectModel, Parameters parameters)
          Match the prepared pattern against the result of getMatchString(Map, Parameters).
 
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

AbstractWildcardMatcher

public AbstractWildcardMatcher()
Method Detail

match

public Map match(String pattern,
                 Map objectModel,
                 Parameters parameters)
          throws PatternException
Match the prepared pattern against the result of getMatchString(Map, Parameters).

Specified by:
match in interface Matcher
Parameters:
pattern - The pattern to match against. Depending on the implementation the pattern can contain wildcards or regular expressions.
objectModel - The Map with object of the calling environment which can be used to select values this matchers matches against.
Returns:
Map The returned Map object with replacements for wildcards/regular-expressions contained in the pattern. If the return value is null there was no match.
Throws:
PatternException
See Also:
AbstractPreparableMatcher.match(java.lang.String, java.util.Map, org.apache.avalon.framework.parameters.Parameters)

getMatchString

protected abstract String getMatchString(Map objectModel,
                                         Parameters parameters)
Get the string to test against the wildcard expression. To be defined by concrete subclasses.



Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.