View Javadoc

1   /*
2    * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/dom/html/HTMLXPath.java,v 1.2 2005/01/30 03:04:33 elharo Exp $
3    * $Revision: 1.2 $
4    * $Date: 2005/01/30 03:04:33 $
5    *
6    * ====================================================================
7    *
8    * Copyright (C) 2000-2003 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: HTMLXPath.java,v 1.2 2005/01/30 03:04:33 elharo Exp $
60   */
61  
62  
63  package org.jaxen.dom.html;
64  
65  import org.jaxen.JaxenException;
66  
67  import org.jaxen.BaseXPath;
68  
69  /***
70   * An XPath implementation for the W3C HTML DOM model
71   *
72   * <p>This is an XPath providing element and attribute case-management
73   * for HTML documents. Because HTML is case-insensitive, but stores DOM
74   * elements in upper case, it is difficult to write XPath queries for HTML
75   * documents which are also compatible with their XHTML equivalents.
76   * This class converts the element, but not attribute, names of an HTML
77   * document to upper or lower case, depending on your specification,
78   * so that lower case [element] xpath expressions will work just as well on
79   * HTML as they do on XHTML (which is case sensitive and enforces
80   * lower case on elements and attributes).  Note that HTML attribute names are
81   * stored as lower case in the HTML (and XHTML) DOM already which is why the
82   * case of attribute names are not modified.
83   *
84   * <p>You create a compiled XPath object, then match it against
85   * one or more context nodes using the {@link #selectNodes(Object)}
86   * method, as in the following example:</p>
87   *
88   * <pre>
89   * XPath path = new HTMLXPath("a/b/c", true); // convert to lower case
90   * List results = path.selectNodes(htmlNode);
91   * </pre>
92   *
93   * @see BaseXPath
94   * @see org.jaxen.dom.DOMXPath
95   *
96   * @author David Peterson
97   *
98   * @version $Revision: 1.2 $
99   */
100 public class HTMLXPath extends BaseXPath
101 {
102     /***
103      * Construct given an XPath expression string.
104      *
105      *  @param xpathExpr the XPath expression
106      *  @param toLowerCase if true, all element names will be considered to
107      *         be lower case. Otherwise, they will be upper case.
108      *
109      *  @throws JaxenException if there is a syntax error while
110      *          parsing the expression
111      */
112     public HTMLXPath(String xpathExpr, boolean toLowerCase) throws JaxenException
113     {
114         super( xpathExpr, DocumentNavigator.getInstance(toLowerCase) );
115     }
116 
117     /***
118      * Constructs a new XPath, treating all elements as lower case.
119      *
120      * @param xpathExpr the XPath expression
121      * @throws JaxenException if there is a syntax error while
122      *          parsing the expression
123      */
124     public HTMLXPath(String xpathExpr) throws JaxenException
125     {
126         this( xpathExpr, true);
127     }
128 
129 }