01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.matching;
18:
19: import org.apache.avalon.framework.parameters.Parameters;
20: import org.apache.cocoon.sitemap.PatternException;
21:
22: import java.util.Map;
23:
24: /**
25: * A matcher that can prepare patterns during sitemap setup for faster match at request time.
26: * This is also a regular matcher, meaning the sitemap can decide either to prepare the pattern
27: * or to match with a request-time evaluated pattern (for {..} substitution).
28: *
29: * @author <a href="mailto:sylvain@apache.org">Sylvain Wallez</a>
30: * @version CVS $Id: PreparableMatcher.java 433543 2006-08-22 06:22:54Z crossley $
31: */
32: public interface PreparableMatcher extends Matcher {
33:
34: /**
35: * Prepares a pattern in a form that allows faster match. For example, a regular
36: * expression matcher can precompile the expression and return the corresponding
37: * object. This method is called once for each pattern used with a particular matcher
38: * class. The returned value is then passed back as the <code>preparedPattern</code>
39: * parameter of {@link #preparedMatch(Object, Map, Parameters)}.
40: *
41: * @param pattern The pattern to prepare. Depending on the implementation the pattern
42: * can contain wildcards or regular expressions.
43: * @return an optimized representation of the pattern.
44: * @throws PatternException if the pattern couldn't be prepared.
45: */
46: Object preparePattern(String pattern) throws PatternException;
47:
48: /**
49: * Matches the prepared pattern against some values in the object model (most often the
50: * <code>Request</code>) and returns a <code>Map</code> object with replacements
51: * for wildcards contained in the pattern.
52: *
53: * @param preparedPattern The preparedPattern to match against, as returned by {@link #preparePattern(String)}.
54: * @param objectModel The <code>Map</code> with objects of the calling environment
55: * which can be used to select values this matchers matches against.
56: * @return a <code>Map</code> object with replacements for wildcards/regular-expressions
57: * contained in the pattern. If the return value is null there was no match.
58: */
59: Map preparedMatch(Object preparedPattern, Map objectModel,
60: Parameters parameters) throws PatternException;
61: }
|