View Javadoc

1   /*
2    * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/pattern/NameTest.java,v 1.5 2002/05/20 08:34:10 jstrachan Exp $
3    * $Revision: 1.5 $
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: NameTest.java,v 1.5 2002/05/20 08:34:10 jstrachan Exp $
60   */
61  
62  package org.jaxen.pattern;
63  
64  import org.jaxen.Context;
65  import org.jaxen.Navigator;
66  
67  /*** <p><code>NameTest</code> tests for a node name.</p>
68    *
69    * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
70    * @version $Revision: 1.5 $
71    */
72  public class NameTest extends NodeTest {
73      
74      /*** The name to match against */
75      private String name;
76      
77      /*** The type of node to match - either attribute or element */
78      private short nodeType;
79      
80      public NameTest(String name, short nodeType)   
81      {
82          this.name = name;
83          this.nodeType = nodeType;
84      }
85          
86      /*** @return true if the pattern matches the given node
87        */
88      public boolean matches( Object node, Context context ) 
89      {
90          Navigator navigator = context.getNavigator();
91          if ( nodeType == Pattern.ELEMENT_NODE ) 
92          {
93              return navigator.isElement( node ) 
94                  && name.equals( navigator.getElementName( node ) );
95          }
96          else if ( nodeType == Pattern.ATTRIBUTE_NODE ) 
97          {
98              return navigator.isAttribute( node )
99                  && name.equals( navigator.getAttributeName( node ) );
100         }
101         else
102         {
103             if ( navigator.isElement( node ) )
104             {
105                 return name.equals( navigator.getElementName( node ) );
106             }
107             else
108             if ( navigator.isAttribute( node ) )
109             {
110                 return name.equals( navigator.getAttributeName( node ) );
111             }
112         }
113         return false;
114     }
115     
116     public double getPriority() 
117     {
118         return 0.0;
119     }
120 
121 
122     public short getMatchType() 
123     {
124         return nodeType;
125     }
126     
127     public String getText() 
128     {
129         if ( nodeType == Pattern.ATTRIBUTE_NODE ) 
130         {
131             return "@" + name;
132         }
133         else 
134         {
135             return name;
136         }
137     }
138     
139     public String toString()
140     {
141         return super.toString() + "[ name: " + name + " type: " + nodeType + " ]";
142     }
143 }