org.atteo.xmlcombiner

Class XmlCombiner

java.lang.Object

org.atteo.xmlcombiner.XmlCombiner

public class XmlCombiner
extends Object

Combines two or more XML DOM trees.

The merging algorithm is as follows:
First direct subelements of selected node are examined. The elements from both trees with matching keys are paired. Based on selected behavior the content of the paired elements is then merged. Finally the paired elements are recursively combined. Any not paired elements are appended.

You can control merging behavior using 'combine.self' and 'combine.children' attributes.

The merging algorithm was inspired by similar functionality in Plexus Utils.

See Also:

merging in Maven, Plexus utils implementation of merging

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XmlCombiner.Filter Allows to filter the result of the merging.

Constructor Summary

Constructors

Constructor and Description
XmlCombiner() Creates XML combiner using default DocumentBuilder.
XmlCombiner(DocumentBuilder documentBuilder)
XmlCombiner(DocumentBuilder documentBuilder, List<String> keyAttributeNames)
XmlCombiner(DocumentBuilder documentBuilder, String keyAttributeNames) Creates XML combiner using given document builder and an id attribute name.
XmlCombiner(List<String> keyAttributeNames)
XmlCombiner(String idAttributeName) Creates XML combiner using given attribute as an id.

Method Summary

Modifier and Type	Method and Description
Document	buildDocument() Return the result of the merging process.
void	buildDocument(OutputStream out) Stores the result of the merging process.
void	buildDocument(Path path) Stores the result of the merging process.
void	combine(Document document) Combine given document.
void	combine(Element element) Combine given element.
void	combine(InputStream stream) Combine given input stream.
void	combine(Path file) Combine given file.
static void	main(String[] args)
void	setFilter(XmlCombiner.Filter filter) Sets the filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlCombiner

public XmlCombiner()
            throws ParserConfigurationException

Creates XML combiner using default DocumentBuilder.

Throws:

ParserConfigurationException - when DocumentBuilder creation fails

XmlCombiner

public XmlCombiner(DocumentBuilder documentBuilder)

XmlCombiner

public XmlCombiner(String idAttributeName)
            throws ParserConfigurationException

Creates XML combiner using given attribute as an id.

Throws:

ParserConfigurationException

XmlCombiner

public XmlCombiner(List<String> keyAttributeNames)
            throws ParserConfigurationException

Throws:

ParserConfigurationException

XmlCombiner

public XmlCombiner(DocumentBuilder documentBuilder,
                   String keyAttributeNames)

Creates XML combiner using given document builder and an id attribute name.

XmlCombiner

public XmlCombiner(DocumentBuilder documentBuilder,
                   List<String> keyAttributeNames)

Method Detail

main

public static void main(String[] args)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException,
                        TransformerException

Throws:

ParserConfigurationException

SAXException

IOException

TransformerException

setFilter

public void setFilter(XmlCombiner.Filter filter)

Sets the filter.

combine

public void combine(Path file)
             throws SAXException,
                    IOException

Combine given file.

Parameters:

file - file to combine

Throws:

SAXException

IOException

combine

public void combine(InputStream stream)
             throws SAXException,
                    IOException

Combine given input stream.

Parameters:

stream - input stream to combine

Throws:

SAXException

IOException

combine

public void combine(Document document)

Combine given document.

Parameters:

document - document to combine

combine

public void combine(Element element)

Combine given element.

Parameters:

element - element to combine

buildDocument

public Document buildDocument()

Return the result of the merging process.

buildDocument

public void buildDocument(OutputStream out)
                   throws TransformerException

Stores the result of the merging process.

Throws:

TransformerException

buildDocument

public void buildDocument(Path path)
                   throws TransformerException,
                          FileNotFoundException

Stores the result of the merging process.

Throws:

TransformerException

FileNotFoundException