| /* |
| * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//digester/src/java/org/apache/commons/digester/RulesBase.java,v 1.8 2002/07/10 18:12:33 rdonkin Exp $ |
| * $Revision: 1.8 $ |
| * $Date: 2002/07/10 18:12:33 $ |
| * |
| * ==================================================================== |
| * |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 1999-2002 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, if |
| * any, must include the following acknowlegement: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowlegement may appear in the software itself, |
| * if and wherever such third-party acknowlegements normally appear. |
| * |
| * 4. The names "The Jakarta Project", "Commons", and "Apache Software |
| * Foundation" must not be used to endorse or promote products derived |
| * from this software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache" |
| * nor may "Apache" appear in their names without prior written |
| * permission of the Apache Group. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| * |
| */ |
| |
| |
| package org.apache.commons.digester; |
| |
| |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.Iterator; |
| import java.util.List; |
| |
| |
| /** |
| * <p>Default implementation of the <code>Rules</code> interface that supports |
| * the standard rule matching behavior. This class can also be used as a |
| * base class for specialized <code>Rules</code> implementations.</p> |
| * |
| * <p>The matching policies implemented by this class support two different |
| * types of pattern matching rules:</p> |
| * <ul> |
| * <li><em>Exact Match</em> - A pattern "a/b/c" exactly matches a |
| * <code><c></code> element, nested inside a <code><b></code> |
| * element, which is nested inside an <code><a></code> element.</li> |
| * <li><em>Tail Match</em> - A pattern "*\/a/b" matches a |
| * <code><b></code> element, nested inside an <code><a></code> |
| * element, no matter how deeply the pair is nested.</li> |
| * </ul> |
| * |
| * @author Craig R. McClanahan |
| * @version $Revision: 1.8 $ $Date: 2002/07/10 18:12:33 $ |
| */ |
| |
| public class RulesBase implements Rules { |
| |
| |
| // ----------------------------------------------------- Instance Variables |
| |
| |
| /** |
| * The set of registered Rule instances, keyed by the matching pattern. |
| * Each value is a List containing the Rules for that pattern, in the |
| * order that they were orginally registered. |
| */ |
| protected HashMap cache = new HashMap(); |
| |
| |
| /** |
| * The Digester instance with which this Rules instance is associated. |
| */ |
| protected Digester digester = null; |
| |
| |
| /** |
| * The namespace URI for which subsequently added <code>Rule</code> |
| * objects are relevant, or <code>null</code> for matching independent |
| * of namespaces. |
| */ |
| protected String namespaceURI = null; |
| |
| |
| /** |
| * The set of registered Rule instances, in the order that they were |
| * originally registered. |
| */ |
| protected ArrayList rules = new ArrayList(); |
| |
| |
| // ------------------------------------------------------------- Properties |
| |
| |
| /** |
| * Return the Digester instance with which this Rules instance is |
| * associated. |
| */ |
| public Digester getDigester() { |
| |
| return (this.digester); |
| |
| } |
| |
| |
| /** |
| * Set the Digester instance with which this Rules instance is associated. |
| * |
| * @param digester The newly associated Digester instance |
| */ |
| public void setDigester(Digester digester) { |
| |
| this.digester = digester; |
| |
| } |
| |
| |
| /** |
| * Return the namespace URI that will be applied to all subsequently |
| * added <code>Rule</code> objects. |
| */ |
| public String getNamespaceURI() { |
| |
| return (this.namespaceURI); |
| |
| } |
| |
| |
| /** |
| * Set the namespace URI that will be applied to all subsequently |
| * added <code>Rule</code> objects. |
| * |
| * @param namespaceURI Namespace URI that must match on all |
| * subsequently added rules, or <code>null</code> for matching |
| * regardless of the current namespace URI |
| */ |
| public void setNamespaceURI(String namespaceURI) { |
| |
| this.namespaceURI = namespaceURI; |
| |
| } |
| |
| |
| // --------------------------------------------------------- Public Methods |
| |
| |
| /** |
| * Register a new Rule instance matching the specified pattern. |
| * |
| * @param pattern Nesting pattern to be matched for this Rule |
| * @param rule Rule instance to be registered |
| */ |
| public void add(String pattern, Rule rule) { |
| |
| List list = (List) cache.get(pattern); |
| if (list == null) { |
| list = new ArrayList(); |
| cache.put(pattern, list); |
| } |
| list.add(rule); |
| rules.add(rule); |
| if (this.namespaceURI != null) { |
| rule.setNamespaceURI(this.namespaceURI); |
| } |
| |
| } |
| |
| |
| /** |
| * Clear all existing Rule instance registrations. |
| */ |
| public void clear() { |
| |
| cache.clear(); |
| rules.clear(); |
| |
| } |
| |
| |
| /** |
| * Return a List of all registered Rule instances that match the specified |
| * nesting pattern, or a zero-length List if there are no matches. If more |
| * than one Rule instance matches, they <strong>must</strong> be returned |
| * in the order originally registered through the <code>add()</code> |
| * method. |
| * |
| * @param pattern Nesting pattern to be matched |
| * |
| * @deprecated Call match(namespaceURI,pattern) instead. |
| */ |
| public List match(String pattern) { |
| |
| return (match(null, pattern)); |
| |
| } |
| |
| |
| /** |
| * Return a List of all registered Rule instances that match the specified |
| * nesting pattern, or a zero-length List if there are no matches. If more |
| * than one Rule instance matches, they <strong>must</strong> be returned |
| * in the order originally registered through the <code>add()</code> |
| * method. |
| * |
| * @param namespaceURI Namespace URI for which to select matching rules, |
| * or <code>null</code> to match regardless of namespace URI |
| * @param pattern Nesting pattern to be matched |
| */ |
| public List match(String namespaceURI, String pattern) { |
| |
| // List rulesList = (List) this.cache.get(pattern); |
| List rulesList = lookup(namespaceURI, pattern); |
| if ((rulesList == null) || (rulesList.size() < 1)) { |
| // Find the longest key, ie more discriminant |
| String longKey = ""; |
| Iterator keys = this.cache.keySet().iterator(); |
| while (keys.hasNext()) { |
| String key = (String) keys.next(); |
| if (key.startsWith("*/")) { |
| if (pattern.equals(key.substring(2)) || |
| pattern.endsWith(key.substring(1))) { |
| if (key.length() > longKey.length()) { |
| // rulesList = (List) this.cache.get(key); |
| rulesList = lookup(namespaceURI, key); |
| longKey = key; |
| } |
| } |
| } |
| } |
| } |
| if (rulesList == null) { |
| rulesList = new ArrayList(); |
| } |
| return (rulesList); |
| |
| } |
| |
| |
| /** |
| * Return a List of all registered Rule instances, or a zero-length List |
| * if there are no registered Rule instances. If more than one Rule |
| * instance has been registered, they <strong>must</strong> be returned |
| * in the order originally registered through the <code>add()</code> |
| * method. |
| */ |
| public List rules() { |
| |
| return (this.rules); |
| |
| } |
| |
| |
| // ------------------------------------------------------ Protected Methods |
| |
| |
| /** |
| * Return a List of Rule instances for the specified pattern that also |
| * match the specified namespace URI (if any). If there are no such |
| * rules, return <code>null</code>. |
| * |
| * @param namespaceURI Namespace URI to match, or <code>null</code> to |
| * select matching rules regardless of namespace URI |
| * @param pattern Pattern to be matched |
| */ |
| protected List lookup(String namespaceURI, String pattern) { |
| |
| // Optimize when no namespace URI is specified |
| List list = (List) this.cache.get(pattern); |
| if (list == null) { |
| return (null); |
| } |
| if ((namespaceURI == null) || (namespaceURI.length() == 0)) { |
| return (list); |
| } |
| |
| // Select only Rules that match on the specified namespace URI |
| ArrayList results = new ArrayList(); |
| Iterator items = list.iterator(); |
| while (items.hasNext()) { |
| Rule item = (Rule) items.next(); |
| if ((namespaceURI.equals(item.getNamespaceURI())) || |
| (item.getNamespaceURI() == null)) { |
| results.add(item); |
| } |
| } |
| return (results); |
| |
| } |
| |
| |
| } |
