01: /*
02: ******************************************************************
03: Copyright (c) 2006-2007, Jeff Martin, Tim Bacon
04: All rights reserved.
05:
06: Redistribution and use in source and binary forms, with or without
07: modification, are permitted provided that the following conditions
08: are met:
09:
10: * Redistributions of source code must retain the above copyright
11: notice, this list of conditions and the following disclaimer.
12: * Redistributions in binary form must reproduce the above
13: copyright notice, this list of conditions and the following
14: disclaimer in the documentation and/or other materials provided
15: with the distribution.
16: * Neither the name of the xmlunit.sourceforge.net nor the names
17: of its contributors may be used to endorse or promote products
18: derived from this software without specific prior written
19: permission.
20:
21: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22: "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23: LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24: FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25: COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26: INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27: BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28: LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29: CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31: ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32: POSSIBILITY OF SUCH DAMAGE.
33:
34: ******************************************************************
35: */
36:
37: package org.custommonkey.xmlunit;
38:
39: import org.custommonkey.xmlunit.exceptions.XpathException;
40:
41: import org.w3c.dom.Document;
42: import org.w3c.dom.NodeList;
43:
44: /**
45: * Abstraction of an engine evaluating XPath expressions.
46: */
47: public interface XpathEngine {
48:
49: /**
50: * Execute the specified xpath syntax <code>select</code> expression
51: * on the specified document and return the list of nodes (could have
52: * length zero) that match
53: * @param select
54: * @param document
55: * @return list of matching nodes
56: */
57: NodeList getMatchingNodes(String select, Document document)
58: throws XpathException;
59:
60: /**
61: * Evaluate the result of executing the specified xpath syntax
62: * <code>select</code> expression on the specified document
63: * @param select
64: * @param document
65: * @return evaluated result
66: */
67: String evaluate(String select, Document document)
68: throws XpathException;
69:
70: /**
71: * Establish a namespace context.
72: */
73: void setNamespaceContext(NamespaceContext ctx);
74: }
|