Using W3C DOM Documents

Introduction

W3C DOM object trees can be used to represent an XML document's structure. It may be convenient to:

pass DOM representations of an XML document as inputs to XML Compare's comparison pipeline, and
get a DOM document as the result of a comparison.

This sample illustrates how DOM documents can be both passed as input and produced as output from a comparison pipeline.

Outline of the Approach

Essentially the approach is to:

Prepare a Saxon processor
Prepare a comparator pipeline (which uses the Saxon processor)
Convert the input DOM documents into Saxon XdmNode trees (using the Saxon processor)
Perform the comparison;
Convert the result into a DOM document.

Preparing a Saxon processor

We construct a new Saxon processor as follows:

JAVA

Processor proc= new Processor(false);

Preparing an XML Compare comparator

We create a pipelined comparator that uses the existing Saxon processor as follows:

JAVA

PipelinedComparatorS9 pc= new PipelinedComparatorS9(proc);

Note, if the supplied Saxon processor is a Saxon HE (Home Edition) processor then there may be compatibility issues if the pipeline uses any filters which in turn use Saxon PE or EE features.

Converting a DOM document into a Saxon XdmNode tree

We make use of a Saxon processor to convert a W3C DOM document (doc) from location (loc) into Saxon XdmNode tree as follows:

JAVA

DOMSource source= new DOMSource(doc, loc);
XdmNode xdmNode= proc.newDocumentBuilder().build(source);

Preparing a DOM destination

We create a Saxon DOM destination as follows:

Comparing the XdmNode trees

We perform the XML comparison as follows.

JAVA

XdmNode result= pc.compare(xdmNode1, xdmNode2);

Convert the resulting XdmNode into a DOM document

We create and populate a DOM document as follows:

JAVA

Document doc= docBuilder.newDocument();
DOMDestination dest= new DOMDestination(doc);
proc.writeXdmValue(result, dest);

Running the sample

Download the sample from https://bitbucket.org/deltaxml/using-w3c-dom.

The sample resources need to be checked-out, cloned or downloaded and unzipped into the samples directory of the XML Compare release. The resources should be located such that they are two levels below the top level release directory, for example DeltaXML-XML-Compare-10_0_0_j/samples/usingDOM.

Details of how to run the sample are given in README.md, displayed in Bitbucket under the list of source files.

Further Details

See the commentary in the UsingDOM.java source file.