org.apache.cocoon.matching
Interface Matcher

All Superinterfaces:
org.apache.avalon.framework.component.Component
All Known Subinterfaces:
PreparableMatcher
All Known Implementing Classes:
AbstractPreparableMatcher, CookieMatcher, HeaderMatcher, ParameterMatcher, RequestAttributeMatcher, RequestParameterMatcher, SessionAttributeMatcher

public interface Matcher
extends org.apache.avalon.framework.component.Component

Version:
CVS $Id: Matcher.java,v 1.4 2002/02/22 07:03:52 cziegeler Exp $
Author:
Giacomo Pati

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 java.util.Map match(java.lang.String pattern, java.util.Map objectModel, org.apache.avalon.framework.parameters.Parameters parameters)
          Matches the pattern against some Request values and returns a Map object with replacements for wildcards contained in the pattern.
 

Field Detail

ROLE

public static final java.lang.String ROLE
See Also:
Constant Field Values
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
Matches the pattern against some Request values and returns a Map object with replacements for wildcards contained in the pattern.

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.
PatternException


Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.