01 /*
02 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
03 *
04 * This code is free software; you can redistribute it and/or modify it
05 * under the terms of the GNU General Public License version 2 only, as
06 * published by the Free Software Foundation. Sun designates this
07 * particular file as subject to the "Classpath" exception as provided
08 * by Sun in the LICENSE file that accompanied this code.
09 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
22 * have any questions.
23 */
24
25 /*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file and, per its terms, should not be removed:
30 *
31 * Copyright (c) 2002 World Wide Web Consortium,
32 * (Massachusetts Institute of Technology, Institut National de
33 * Recherche en Informatique et en Automatique, Keio University). All
34 * Rights Reserved. This program is distributed under the W3C's Software
35 * Intellectual Property License. This program is distributed in the
36 * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
37 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
38 * PURPOSE.
39 * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
40 */
41
42 package org.w3c.dom.xpath;
43
44 import org.w3c.dom.Node;
45 import org.w3c.dom.DOMException;
46
47 /**
48 * The <code>XPathExpression</code> interface represents a parsed and resolved
49 * XPath expression.
50 * <p>See also the <a href='http://www.w3.org/2002/08/WD-DOM-Level-3-XPath-20020820'>Document Object Model (DOM) Level 3 XPath Specification</a>.
51 */
52 public interface XPathExpression {
53 /**
54 * Evaluates this XPath expression and returns a result.
55 * @param contextNode The <code>context</code> is context node for the
56 * evaluation of this XPath expression.If the XPathEvaluator was
57 * obtained by casting the <code>Document</code> then this must be
58 * owned by the same document and must be a <code>Document</code>,
59 * <code>Element</code>, <code>Attribute</code>, <code>Text</code>,
60 * <code>CDATASection</code>, <code>Comment</code>,
61 * <code>ProcessingInstruction</code>, or <code>XPathNamespace</code>
62 * node.If the context node is a <code>Text</code> or a
63 * <code>CDATASection</code>, then the context is interpreted as the
64 * whole logical text node as seen by XPath, unless the node is empty
65 * in which case it may not serve as the XPath context.
66 * @param type If a specific <code>type</code> is specified, then the
67 * result will be coerced to return the specified type relying on
68 * XPath conversions and fail if the desired coercion is not possible.
69 * This must be one of the type codes of <code>XPathResult</code>.
70 * @param result The <code>result</code> specifies a specific result
71 * object which may be reused and returned by this method. If this is
72 * specified as <code>null</code>or the implementation does not reuse
73 * the specified result, a new result object will be constructed and
74 * returned.For XPath 1.0 results, this object will be of type
75 * <code>XPathResult</code>.
76 * @return The result of the evaluation of the XPath expression.For XPath
77 * 1.0 results, this object will be of type <code>XPathResult</code>.
78 * @exception XPathException
79 * TYPE_ERR: Raised if the result cannot be converted to return the
80 * specified type.
81 * @exception DOMException
82 * WRONG_DOCUMENT_ERR: The Node is from a document that is not supported
83 * by the XPathEvaluator that created this <code>XPathExpression</code>
84 * .
85 * <br>NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath
86 * context node or the request type is not permitted by this
87 * <code>XPathExpression</code>.
88 */
89 public Object evaluate(Node contextNode, short type, Object result)
90 throws XPathException, DOMException;
91
92 }
|