View Javadoc

1   /*
2    * $Header$
3    * $Revision: 1161 $
4    * $Date: 2006-06-03 13:36:00 -0700 (Sat, 03 Jun 2006) $
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: JDOMXPath.java 1161 2006-06-03 20:36:00Z elharo $
46   */
47  
48  
49  package org.jaxen.jdom;
50  
51  import org.jaxen.BaseXPath;
52  import org.jaxen.JaxenException;
53  
54  /** An XPath implementation for the JDOM model
55   *
56   * <p>This is the main entry point for matching an XPath against a DOM
57   * tree.  You create a compiled XPath object, then match it against
58   * one or more context nodes using the {@link #selectNodes(Object)}
59   * method, as in the following example:</p>
60   *
61   * <pre>
62   * Object jdomNode = ...; // Document, Element etc.
63   * XPath path = new JDOMXPath("a/b/c");
64   * List results = path.selectNodes(jdomNode);
65   * </pre>
66   *
67   * @see BaseXPath
68   * @see <a href="http://jdom.org/">The JDOM website</a>
69   *
70   * @author <a href="mailto:bob@werken.com">bob mcwhirter</a>
71   * @author <a href="mailto:jstachan@apache.org">James Strachan</a>
72   *
73   * @version $Revision: 1161 $
74   */
75  public class JDOMXPath extends BaseXPath
76  {
77      /**
78       * 
79       */
80      private static final long serialVersionUID = 6426091824802286928L;
81  
82      /** Construct given an XPath expression string.
83       *
84       *  @param xpathExpr the XPath expression.
85       *
86       *  @throws JaxenException if there is a syntax error while
87       *          parsing the expression
88       */
89      public JDOMXPath(String xpathExpr) throws JaxenException
90      {
91          super( xpathExpr, DocumentNavigator.getInstance() );
92      }
93  }