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.component.Component;
20: import org.apache.avalon.framework.parameters.Parameters;
21: import org.apache.cocoon.sitemap.PatternException;
22:
23: import java.util.Map;
24:
25: /**
26: *
27: * @author <a href="mailto:Giacomo.Pati@pwr.ch">Giacomo Pati</a>
28: * @version CVS $Id: Matcher.java 433543 2006-08-22 06:22:54Z crossley $
29: */
30: public interface Matcher extends Component {
31:
32: String ROLE = Matcher.class.getName();
33:
34: /**
35: * Matches the pattern against some <code>Request</code> values
36: * and returns a <code>Map</code> object with replacements
37: * for wildcards contained in the pattern.
38: * @param pattern The pattern to match against. Depending on the
39: * implementation the pattern can contain wildcards
40: * or regular expressions.
41: * @param objectModel The <code>Map</code> with object of the
42: * calling environment which can be used
43: * to select values this matchers matches against.
44: * @return Map The returned <code>Map</code> object with
45: * replacements for wildcards/regular-expressions
46: * contained in the pattern.
47: * If the return value is null there was no match.
48: */
49: Map match(String pattern, Map objectModel, Parameters parameters)
50: throws PatternException;
51: }
|