org.apache.cocoon.matching
Class AbstractPreparableMatcher

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.matching.AbstractPreparableMatcher

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, org.apache.avalon.framework.logger.Loggable, Matcher, PreparableMatcher

Direct Known Subclasses:

AbstractRegexpMatcher, AbstractWildcardMatcher

public abstract class AbstractPreparableMatcher

extends org.apache.avalon.framework.logger.AbstractLoggable

implements PreparableMatcher

A matcher that can prepare patterns during sitemap setup for faster match at request time. This is also a regular matcher, meaning the sitemap can decide either to prepare the pattern or to match with a request-time evaluated pattern (for {..} substitution).

Version:

CVS $Id: AbstractPreparableMatcher.java,v 1.4 2002/02/22 07:03:52 cziegeler Exp $

Author:

Sylvain Wallez

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

ROLE

Constructor Summary

AbstractPreparableMatcher()

Method Summary

java.util.Map

match(java.lang.String pattern, java.util.Map objectModel, org.apache.avalon.framework.parameters.Parameters parameters) Match the pattern by preparing it and matching the prepared pattern.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable

getLogger, setLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.matching.PreparableMatcher

preparedMatch, preparePattern

Constructor Detail

AbstractPreparableMatcher

public AbstractPreparableMatcher()

Method Detail

match

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

Match the pattern by preparing it and matching the prepared pattern.

Specified by:

match in interface Matcher

Following copied from interface: org.apache.cocoon.matching.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.