View Javadoc

1   /*
2    * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
3    *
4    * This software is open source.
5    * See the bottom of this file for the licence.
6    */
7   
8   package org.dom4j.rule.pattern;
9   
10  import org.dom4j.Node;
11  import org.dom4j.NodeFilter;
12  import org.dom4j.rule.Pattern;
13  
14  /***
15   * <p>
16   * <code>DefaultPattern</code> a default implementation of Pattern which can
17   * take any XPath implementation or NodeFilter for defining the pattern.
18   * <b>WARNING </b> this implementation causes a worst case, brute force XSLT
19   * rule evaluation to be performed. Wherever possible the methods {@link
20   * #getPriority}, {@link #getMatchType}and {@link #getMatchesNodeName}should
21   * be overloaded to allow more rule filtering to occur.
22   * </p>
23   * 
24   * @author <a href="mailto:james.strachan@metastuff.com">James Strachan </a>
25   * @version $Revision: 1.6 $
26   */
27  public class DefaultPattern implements Pattern {
28      private NodeFilter filter;
29  
30      public DefaultPattern(NodeFilter filter) {
31          this.filter = filter;
32      }
33  
34      public boolean matches(Node node) {
35          return filter.matches(node);
36      }
37  
38      public double getPriority() {
39          return Pattern.DEFAULT_PRIORITY;
40      }
41  
42      public Pattern[] getUnionPatterns() {
43          return null;
44      }
45  
46      public short getMatchType() {
47          return ANY_NODE;
48      }
49  
50      public String getMatchesNodeName() {
51          return null;
52      }
53  }
54  
55  /*
56   * Redistribution and use of this software and associated documentation
57   * ("Software"), with or without modification, are permitted provided that the
58   * following conditions are met:
59   * 
60   * 1. Redistributions of source code must retain copyright statements and
61   * notices. Redistributions must also contain a copy of this document.
62   * 
63   * 2. Redistributions in binary form must reproduce the above copyright notice,
64   * this list of conditions and the following disclaimer in the documentation
65   * and/or other materials provided with the distribution.
66   * 
67   * 3. The name "DOM4J" must not be used to endorse or promote products derived
68   * from this Software without prior written permission of MetaStuff, Ltd. For
69   * written permission, please contact dom4j-info@metastuff.com.
70   * 
71   * 4. Products derived from this Software may not be called "DOM4J" nor may
72   * "DOM4J" appear in their names without prior written permission of MetaStuff,
73   * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
74   * 
75   * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
76   * 
77   * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
78   * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
79   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
80   * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
81   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
82   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
83   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
84   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
85   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
86   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
87   * POSSIBILITY OF SUCH DAMAGE.
88   * 
89   * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
90   */