View Javadoc

1   /*
2    * $Header$
3    * $Revision$
4    * $Date$
5    *
6    * ====================================================================
7    *
8    * Copyright 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 are
13   * met:
14   * 
15   *   * Redistributions of source code must retain the above copyright
16   *     notice, this list of conditions and the following disclaimer.
17   * 
18   *   * Redistributions in binary form must reproduce the above copyright
19   *     notice, this list of conditions and the following disclaimer in the
20   *     documentation and/or other materials provided with the distribution.
21   * 
22   *   * Neither the name of the Jaxen Project nor the names of its
23   *     contributors may be used to endorse or promote products derived 
24   *     from this software without specific prior written permission.
25   * 
26   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
27   * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28   * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
29   * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
30   * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31   * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32   * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33   * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34   * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35   * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37   *
38   * ====================================================================
39   * This software consists of voluntary contributions made by many 
40   * individuals on behalf of the Jaxen Project and was originally 
41   * created by bob mcwhirter <bob@werken.com> and 
42   * James Strachan <jstrachan@apache.org>.  For more information on the 
43   * Jaxen Project, please see <http://www.jaxen.org/>.
44   * 
45   * $Id$
46   */
47  
48  package org.jaxen.pattern;
49  
50  import org.jaxen.Context;
51  
52  /** <p><code>NodeTypeTest</code> matches if the node is of a certain type 
53    * such as element, attribute, comment, text, processing instruction and so forth.</p>
54    *
55    * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
56    * @version $Revision$
57    * @deprecated will be removed in Jaxen 2.0
58    */
59  public class NodeTypeTest extends NodeTest {
60      
61      public static final NodeTypeTest DOCUMENT_TEST 
62          = new NodeTypeTest( DOCUMENT_NODE );
63      
64      public static final NodeTypeTest ELEMENT_TEST 
65          = new NodeTypeTest( ELEMENT_NODE );
66      
67      public static final NodeTypeTest ATTRIBUTE_TEST 
68          = new NodeTypeTest( ATTRIBUTE_NODE );
69      
70      public static final NodeTypeTest COMMENT_TEST 
71          = new NodeTypeTest( COMMENT_NODE );
72      
73      public static final NodeTypeTest TEXT_TEST 
74          = new NodeTypeTest( TEXT_NODE );
75      
76      public static final NodeTypeTest PROCESSING_INSTRUCTION_TEST 
77          = new NodeTypeTest( PROCESSING_INSTRUCTION_NODE );
78      
79      public static final NodeTypeTest NAMESPACE_TEST 
80          = new NodeTypeTest( NAMESPACE_NODE );
81      
82      
83      private short nodeType;
84      
85      public NodeTypeTest(short nodeType)   
86      {
87          this.nodeType = nodeType;
88      }
89          
90      /** @return true if the pattern matches the given node
91        */
92      public boolean matches( Object node, Context context ) 
93      {
94          return nodeType == context.getNavigator().getNodeType( node );
95      }
96      
97      public double getPriority() 
98      {
99          return -0.5;
100     }
101 
102 
103     public short getMatchType() 
104     {
105         return nodeType;
106     }
107     
108     public String getText() 
109     {
110         switch (nodeType) 
111         {
112             case ELEMENT_NODE:
113                 return "child()";
114             case ATTRIBUTE_NODE:
115                 return "@*";
116             case NAMESPACE_NODE:
117                 return "namespace()";
118             case DOCUMENT_NODE:
119                 return "/";
120             case COMMENT_NODE:
121                 return "comment()";
122             case TEXT_NODE:
123                 return "text()";
124             case PROCESSING_INSTRUCTION_NODE:
125                 return "processing-instruction()";
126         }
127         return "";
128     }
129     
130     public String toString()
131     {
132         return super.toString() + "[ type: " + nodeType + " ]";
133     }
134 }