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.logger.AbstractLogEnabled;
20: import org.apache.avalon.framework.parameters.Parameters;
21: import org.apache.avalon.framework.thread.ThreadSafe;
22: import org.apache.cocoon.sitemap.PatternException;
23: import org.apache.cocoon.sitemap.SitemapParameters;
24: import org.apache.cocoon.util.WildcardMatcherHelper;
25:
26: import java.util.Map;
27:
28: /**
29: * Base class for wildcard matchers
30: *
31: * @author <a href="mailto:sylvain@apache.org">Sylvain Wallez</a>
32: * @version $Id: AbstractWildcardMatcher.java 433543 2006-08-22 06:22:54Z crossley $
33: */
34:
35: public abstract class AbstractWildcardMatcher extends
36: AbstractLogEnabled implements Matcher, ThreadSafe {
37:
38: /**
39: * Match the prepared pattern against the result of {@link #getMatchString(Map, Parameters)}.
40: * @see org.apache.cocoon.matching.AbstractPreparableMatcher#match(java.lang.String, java.util.Map, org.apache.avalon.framework.parameters.Parameters)
41: */
42: public Map match(String pattern, Map objectModel,
43: Parameters parameters) throws PatternException {
44: if (pattern == null) {
45: throw new PatternException("A pattern is needed at "
46: + SitemapParameters.getLocation(parameters));
47: }
48:
49: final String match = this .getMatchString(objectModel,
50: parameters);
51:
52: if (match == null) {
53: return null;
54: }
55:
56: return WildcardMatcherHelper.match(pattern, match);
57: }
58:
59: /**
60: * Get the string to test against the wildcard expression. To be defined
61: * by concrete subclasses.
62: */
63: protected abstract String getMatchString(Map objectModel,
64: Parameters parameters);
65: }
|