01: /*
02: ******************************************************************
03: Copyright (c) 2001-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.w3c.dom.Element;
40: import org.w3c.dom.Node;
41:
42: /**
43: * Simple interface implementation that tests two elements for name
44: * comparability. This class provides the default behaviour within a
45: * DifferenceEngine (for backwards compatibility)
46: * <br />Examples and more at
47: * <a href="http://xmlunit.sourceforge.net"/>xmlunit.sourceforge.net</a>
48: * @see DifferenceEngine#compareNodeList(NodeList, NodeList, int, DifferenceListener, ElementQualifier)
49: * @see Diff#overrideElementQualifier(ElementQualifier)
50: */
51: public class ElementNameQualifier implements ElementQualifier {
52: /**
53: * Determine whether two elements qualify for further Difference comparison.
54: * @param control
55: * @param test
56: * @return true if the two elements qualify for further comparison based on
57: * their similar namespace URI and non-namespaced tag name,
58: * false otherwise
59: */
60: public boolean qualifyForComparison(Element control, Element test) {
61: return control != null
62: && test != null
63: && equalsNamespace(control, test)
64: && getNonNamespacedNodeName(control).equals(
65: getNonNamespacedNodeName(test));
66: }
67:
68: /**
69: * Determine whether two nodes are defined by the same namespace URI
70: * @param control
71: * @param test
72: * @return true if the two nodes are both defined by the same namespace URI
73: * (including the default - empty - namespace), false otherwise
74: */
75: protected boolean equalsNamespace(Node control, Node test) {
76: String controlNS = control.getNamespaceURI();
77: String testNS = test.getNamespaceURI();
78: if (controlNS == null) {
79: return testNS == null;
80: }
81: return controlNS.equals(testNS);
82: }
83:
84: /**
85: * Strip any namespace information off a node name
86: * @param node
87: * @return the localName if the node is namespaced, or the name otherwise
88: */
89: protected String getNonNamespacedNodeName(Node node) {
90: String name = node.getLocalName();
91: if (name == null) {
92: return node.getNodeName();
93: }
94: return name;
95: }
96:
97: }
|