1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Oracle designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Oracle in the LICENSE file that accompanied this code.
9 *
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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * 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
45 import org.w3c.dom.Node;
46 import org.w3c.dom.DOMException;
47
48 /**
49 * The <code>XPathExpression</code> interface represents a parsed and resolved
50 * XPath expression.
51 * <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>.
52 */
53 public interface XPathExpression {
54 /**
55 * Evaluates this XPath expression and returns a result.
56 * @param contextNode The <code>context</code> is context node for the
57 * evaluation of this XPath expression.If the XPathEvaluator was
58 * obtained by casting the <code>Document</code> then this must be
59 * owned by the same document and must be a <code>Document</code>,
60 * <code>Element</code>, <code>Attribute</code>, <code>Text</code>,
61 * <code>CDATASection</code>, <code>Comment</code>,
62 * <code>ProcessingInstruction</code>, or <code>XPathNamespace</code>
63 * node.If the context node is a <code>Text</code> or a
64 * <code>CDATASection</code>, then the context is interpreted as the
65 * whole logical text node as seen by XPath, unless the node is empty
66 * in which case it may not serve as the XPath context.
67 * @param type If a specific <code>type</code> is specified, then the
68 * result will be coerced to return the specified type relying on
69 * XPath conversions and fail if the desired coercion is not possible.
70 * This must be one of the type codes of <code>XPathResult</code>.
71 * @param result The <code>result</code> specifies a specific result
72 * object which may be reused and returned by this method. If this is
73 * specified as <code>null</code>or the implementation does not reuse
74 * the specified result, a new result object will be constructed and
75 * returned.For XPath 1.0 results, this object will be of type
76 * <code>XPathResult</code>.
77 * @return The result of the evaluation of the XPath expression.For XPath
78 * 1.0 results, this object will be of type <code>XPathResult</code>.
79 * @exception XPathException
80 * TYPE_ERR: Raised if the result cannot be converted to return the
81 * specified type.
82 * @exception DOMException
83 * WRONG_DOCUMENT_ERR: The Node is from a document that is not supported
84 * by the XPathEvaluator that created this <code>XPathExpression</code>
85 * .
86 * <br>NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath
87 * context node or the request type is not permitted by this
88 * <code>XPathExpression</code>.
89 */
90 public Object evaluate(Node contextNode,
91 short type,
92 Object result)
93 throws XPathException, DOMException;
94
95 }