1 |
14 |
jlechner |
/* XPath.java --
|
2 |
|
|
Copyright (C) 2004 Free Software Foundation, Inc.
|
3 |
|
|
|
4 |
|
|
This file is part of GNU Classpath.
|
5 |
|
|
|
6 |
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
7 |
|
|
it under the terms of the GNU General Public License as published by
|
8 |
|
|
the Free Software Foundation; either version 2, or (at your option)
|
9 |
|
|
any later version.
|
10 |
|
|
|
11 |
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
12 |
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
13 |
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
14 |
|
|
General Public License for more details.
|
15 |
|
|
|
16 |
|
|
You should have received a copy of the GNU General Public License
|
17 |
|
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
18 |
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
19 |
|
|
02110-1301 USA.
|
20 |
|
|
|
21 |
|
|
Linking this library statically or dynamically with other modules is
|
22 |
|
|
making a combined work based on this library. Thus, the terms and
|
23 |
|
|
conditions of the GNU General Public License cover the whole
|
24 |
|
|
combination.
|
25 |
|
|
|
26 |
|
|
As a special exception, the copyright holders of this library give you
|
27 |
|
|
permission to link this library with independent modules to produce an
|
28 |
|
|
executable, regardless of the license terms of these independent
|
29 |
|
|
modules, and to copy and distribute the resulting executable under
|
30 |
|
|
terms of your choice, provided that you also meet, for each linked
|
31 |
|
|
independent module, the terms and conditions of the license of that
|
32 |
|
|
module. An independent module is a module which is not derived from
|
33 |
|
|
or based on this library. If you modify this library, you may extend
|
34 |
|
|
this exception to your version of the library, but you are not
|
35 |
|
|
obligated to do so. If you do not wish to do so, delete this
|
36 |
|
|
exception statement from your version. */
|
37 |
|
|
|
38 |
|
|
package javax.xml.xpath;
|
39 |
|
|
|
40 |
|
|
import javax.xml.namespace.NamespaceContext;
|
41 |
|
|
import javax.xml.namespace.QName;
|
42 |
|
|
import org.xml.sax.InputSource;
|
43 |
|
|
|
44 |
|
|
/**
|
45 |
|
|
* Interface to the XPath evaluation environment.
|
46 |
|
|
* @since 1.3
|
47 |
|
|
*/
|
48 |
|
|
public interface XPath
|
49 |
|
|
{
|
50 |
|
|
|
51 |
|
|
/**
|
52 |
|
|
* Resets the environment.
|
53 |
|
|
*/
|
54 |
|
|
void reset();
|
55 |
|
|
|
56 |
|
|
void setXPathVariableResolver(XPathVariableResolver resolver);
|
57 |
|
|
|
58 |
|
|
XPathVariableResolver getXPathVariableResolver();
|
59 |
|
|
|
60 |
|
|
void setXPathFunctionResolver(XPathFunctionResolver resolver);
|
61 |
|
|
|
62 |
|
|
XPathFunctionResolver getXPathFunctionResolver();
|
63 |
|
|
|
64 |
|
|
void setNamespaceContext(NamespaceContext nsContext);
|
65 |
|
|
|
66 |
|
|
NamespaceContext getNamespaceContext();
|
67 |
|
|
|
68 |
|
|
/**
|
69 |
|
|
* Compiles an XPath expression for future evaluation.
|
70 |
|
|
* @param expression the expression
|
71 |
|
|
*/
|
72 |
|
|
XPathExpression compile(String expression)
|
73 |
|
|
throws XPathExpressionException;
|
74 |
|
|
|
75 |
|
|
/**
|
76 |
|
|
* Evaluates an expression.
|
77 |
|
|
* @param expression the expression
|
78 |
|
|
* @param item the expression context
|
79 |
|
|
* @param returnType the desired return type
|
80 |
|
|
*/
|
81 |
|
|
Object evaluate(String expression,
|
82 |
|
|
Object item,
|
83 |
|
|
QName returnType)
|
84 |
|
|
throws XPathExpressionException;
|
85 |
|
|
|
86 |
|
|
/**
|
87 |
|
|
* Evaluates an expression and returns the result as a string.
|
88 |
|
|
* @param expression the expression
|
89 |
|
|
* @param item the expression context
|
90 |
|
|
*/
|
91 |
|
|
String evaluate(String expression,
|
92 |
|
|
Object item)
|
93 |
|
|
throws XPathExpressionException;
|
94 |
|
|
|
95 |
|
|
/**
|
96 |
|
|
* Evaluates an expression.
|
97 |
|
|
* @param expression the expression
|
98 |
|
|
* @param source the source to load the expression context from
|
99 |
|
|
* @param returnType the desired return type
|
100 |
|
|
*/
|
101 |
|
|
Object evaluate(String expression,
|
102 |
|
|
InputSource source,
|
103 |
|
|
QName returnType)
|
104 |
|
|
throws XPathExpressionException;
|
105 |
|
|
|
106 |
|
|
/**
|
107 |
|
|
* Evaluates an expression and returns the result as a string.
|
108 |
|
|
* @param expression the expression
|
109 |
|
|
* @param source the source to load the expression context from
|
110 |
|
|
*/
|
111 |
|
|
String evaluate(String expression,
|
112 |
|
|
InputSource source)
|
113 |
|
|
throws XPathExpressionException;
|
114 |
|
|
|
115 |
|
|
}
|