1 /*
2 * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/jdom/JDOMXPath.java,v 1.6 2005/06/28 13:44:46 elharo Exp $
3 * $Revision: 1.6 $
4 * $Date: 2005/06/28 13:44:46 $
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: JDOMXPath.java,v 1.6 2005/06/28 13:44:46 elharo Exp $
60 */
61
62
63 package org.jaxen.jdom;
64
65 import org.jaxen.BaseXPath;
66 import org.jaxen.JaxenException;
67
68 /*** An XPath implementation for the JDOM model
69 *
70 * <p>This is the main entry point for matching an XPath against a DOM
71 * tree. You create a compiled XPath object, then match it against
72 * one or more context nodes using the {@link #selectNodes(Object)}
73 * method, as in the following example:</p>
74 *
75 * <pre>
76 * Object jdomNode = ...; // Document, Element etc.
77 * XPath path = new JDOMXPath("a/b/c");
78 * List results = path.selectNodes(jdomNode);
79 * </pre>
80 *
81 * @see BaseXPath
82 * @see <a href="http://jdom.org/">The JDOM website</a>
83 *
84 * @author <a href="mailto:bob@werken.com">bob mcwhirter</a>
85 * @author <a href="mailto:jstachan@apache.org">James Strachan</a>
86 *
87 * @version $Revision: 1.6 $
88 */
89 public class JDOMXPath extends BaseXPath
90 {
91 /*** Construct given an XPath expression string.
92 *
93 * @param xpathExpr the XPath expression.
94 *
95 * @throws JaxenException if there is a syntax error while
96 * parsing the expression
97 */
98 public JDOMXPath(String xpathExpr) throws JaxenException
99 {
100 super( xpathExpr, DocumentNavigator.getInstance() );
101 }
102 }