View Javadoc

1   /*
2    * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/pattern/NodeTypeTest.java,v 1.6 2002/05/20 08:34:10 jstrachan Exp $
3    * $Revision: 1.6 $
4    * $Date: 2002/05/20 08:34:10 $
5    *
6    * ====================================================================
7    *
8    * Copyright (C) 2000-2002 bob mcwhirter & James Strachan.
9    * All rights reserved.
10   *
11   * Redistribution and use in source and binary forms, with or without
12   * modification, are permitted provided that the following conditions
13   * are met:
14   * 
15   * 1. Redistributions of source code must retain the above copyright
16   *    notice, this list of conditions, and the following disclaimer.
17   *
18   * 2. Redistributions in binary form must reproduce the above copyright
19   *    notice, this list of conditions, and the disclaimer that follows 
20   *    these conditions in the documentation and/or other materials 
21   *    provided with the distribution.
22   *
23   * 3. The name "Jaxen" must not be used to endorse or promote products
24   *    derived from this software without prior written permission.  For
25   *    written permission, please contact license@jaxen.org.
26   * 
27   * 4. Products derived from this software may not be called "Jaxen", nor
28   *    may "Jaxen" appear in their name, without prior written permission
29   *    from the Jaxen Project Management (pm@jaxen.org).
30   * 
31   * In addition, we request (but do not require) that you include in the 
32   * end-user documentation provided with the redistribution and/or in the 
33   * software itself an acknowledgement equivalent to the following:
34   *     "This product includes software developed by the
35   *      Jaxen Project (http://www.jaxen.org/)."
36   * Alternatively, the acknowledgment may be graphical using the logos 
37   * available at http://www.jaxen.org/
38   *
39   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
40   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
42   * DISCLAIMED.  IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT
43   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
46   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
47   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
49   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50   * SUCH DAMAGE.
51   *
52   * ====================================================================
53   * This software consists of voluntary contributions made by many 
54   * individuals on behalf of the Jaxen Project and was originally 
55   * created by bob mcwhirter <bob@werken.com> and 
56   * James Strachan <jstrachan@apache.org>.  For more information on the 
57   * Jaxen Project, please see <http://www.jaxen.org/>.
58   * 
59   * $Id: NodeTypeTest.java,v 1.6 2002/05/20 08:34:10 jstrachan Exp $
60   */
61  
62  package org.jaxen.pattern;
63  
64  import org.jaxen.Context;
65  
66  /*** <p><code>NodeTypeTest</code> matches if the node is of a certain type 
67    * such as element, attribute, comment, text, processing instruction and so forth.</p>
68    *
69    * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
70    * @version $Revision: 1.6 $
71    */
72  public class NodeTypeTest extends NodeTest {
73      
74      public static final NodeTypeTest DOCUMENT_TEST 
75          = new NodeTypeTest( DOCUMENT_NODE );
76      
77      public static final NodeTypeTest ELEMENT_TEST 
78          = new NodeTypeTest( ELEMENT_NODE );
79      
80      public static final NodeTypeTest ATTRIBUTE_TEST 
81          = new NodeTypeTest( ATTRIBUTE_NODE );
82      
83      public static final NodeTypeTest COMMENT_TEST 
84          = new NodeTypeTest( COMMENT_NODE );
85      
86      public static final NodeTypeTest TEXT_TEST 
87          = new NodeTypeTest( TEXT_NODE );
88      
89      public static final NodeTypeTest PROCESSING_INSTRUCTION_TEST 
90          = new NodeTypeTest( PROCESSING_INSTRUCTION_NODE );
91      
92      public static final NodeTypeTest NAMESPACE_TEST 
93          = new NodeTypeTest( NAMESPACE_NODE );
94      
95      
96      private short nodeType;
97      
98      public NodeTypeTest(short nodeType)   
99      {
100         this.nodeType = nodeType;
101     }
102         
103     /*** @return true if the pattern matches the given node
104       */
105     public boolean matches( Object node, Context context ) 
106     {
107         return nodeType == context.getNavigator().getNodeType( node );
108     }
109     
110     public double getPriority() 
111     {
112         return -0.5;
113     }
114 
115 
116     public short getMatchType() 
117     {
118         return nodeType;
119     }
120     
121     public String getText() 
122     {
123         switch (nodeType) 
124         {
125             case ELEMENT_NODE:
126                 return "child()";
127             case ATTRIBUTE_NODE:
128                 return "@*";
129             case NAMESPACE_NODE:
130                 return "namespace()";
131             case DOCUMENT_NODE:
132                 return "/";
133             case COMMENT_NODE:
134                 return "comment()";
135             case TEXT_NODE:
136                 return "text()";
137             case PROCESSING_INSTRUCTION_NODE:
138                 return "processing-instruction()";
139         }
140         return "";
141     }
142     
143     public String toString()
144     {
145         return super.toString() + "[ type: " + nodeType + " ]";
146     }
147 }