How to read XML using XPath in Java

java

xpath

xml-parsing

java-xml

byAnton Shumikhin·Dec 27, 2024

Reading XML with XPath in Java is a tale of two halves: a Document to parse the XML, and an XPath instance for queries. Use 'em like this:

import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.xpath.XPathFactory;
import javax.xml.xpath.XPathConstants;
import org.w3c.dom.NodeList;
import org.w3c.dom.Document;

// Parse the XML into a Document. Think of it as making a blueprint out of spaghetti code.
Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse("yourfile.xml");
document.normalize(); // If your XML was a teenager, this is like cleaning its room.

// Time to query! Just compile the XPath expression and let it rip!
String expr = "/path/to/target";
NodeList result = (NodeList) XPathFactory.newInstance().newXPath().compile(expr).evaluate(document, XPathConstants.NODESET);

// What did we get? Print out the node content to see!
for (int i = 0; i < result.getLength(); i++) {
    System.out.println(result.item(i).getTextContent());
}

Emphasis here is on the Document for XML parsing, and XPath for query execution. And remember - XPathConstants is the decoder ring for your query results!

Wiring XPath to XML

Extracting Text Content

In XML, your key info is often in text nodes. To extract these guys, especially when they're hiding behind attributes, you can use XPathConstants.STRING. Here is how:

String nodeName = (String) XPathFactory.newInstance().newXPath().compile("/complex/path/nodeName").evaluate(document, XPathConstants.STRING);
System.out.println(nodeName); // This will display the text content of nodeName

Operating with Node Sets

When it comes to large amounts of data, use XPathConstants.NODESET to gather all nodes into an army of data or, more technically, a NodeList:

NodeList nodeList = (NodeList) XPathFactory.newInstance().newXPath().compile("//tagName").evaluate(document, XPathConstants.NODESET);

// Command your army to reveal their secrets!
for (int i = 0; i < nodeList.getLength(); i++) {
    System.out.println(nodeList.item(i).getTextContent());
}

Namespace Nightmares

XML with namespaces is like a family reunion with too many relatives named Bob. XPath expressions need to handle these guys. You can use namespace context maps to keep tabs on all of your Uncle Bobs.

Error Handling

Wrap your XML magic in a try-catch block to handle mischievous exceptions. Good logging practice: if an exception crashes your party, at least have it announce its name and what song it disliked.

Conquering Complexities

Advanced XPath Techniques

XPath expressions can handle complex conditions, calculations, and even regex pattern matching. It's like your XML data's personal Swiss Army knife.

Converting Node to String

Sometimes you'll need to turn nodes into strings:

TransformerFactory transformerFactory = TransformerFactory.newInstance();
StringWriter stringWriter = new StringWriter();
transformerFactory.newTransformer().transform(new DOMSource(node), new StreamResult(stringWriter));
String nodeAsString = stringWriter.toString();

Power tools for large data wielders

Documents that have seen too much may need heavy-duty parsing/modifying. Libraries like vtd-xml offer muscle-car performance.

Testing Realm

JUnit is to Java what DataProvider and Test annotations are to XML. Wear these tools like a badge of honour – they prove your XPath code works and plays well with every variety of XML document.

explain-codes / Java / How to read XML using XPath in Java

Linked

Xpath: Get Following Sibling



How to use HTML Agility pack



Best way to compare 2 XML documents in Java



In Java, how do I parse XML as a String instead of a file?



How to find files that match a wildcard string in Java?

