DataTree

Simple way to generate XML documents and schemas using Java, but feeling like Clojure.

Requires Java 7 or greater.

User Guide

Getting Started

Get this library from Maven Central using the following dependency:

<dependency>
    <groupId>fi.solita.datatree</groupId>
    <artifactId>datatree</artifactId>
    <version>1.0.0</version>
</dependency>

Add static imports for the factory methods in the Tree class:

import static fi.solita.datatree.Tree.*;

Now you can describe an XML document as a series of nested calls to tree and meta. Here are some examples:

tree("element", "some text") becomes <element>some text</element>

tree("element", meta("attribute", "value")) becomes <element attribute="value"/>

tree("outer", tree("inner-1"), tree("inner-2")) becomes <outer><inner-1/><inner-2/></outer>

To convert a tree into XML, you can use one of the various methods in XmlGenerator:

Tree tree = tree("some-tree");
InputStream in = XmlGenerator.toInputStream(tree);

Creating XML Schemas

There are helper methods in XmlSchema for generating XML Schemas. First do a static import for them:

import static fi.solita.datatree.xml.XmlSchema.*;

And then use those to generate a tree that represents the schema:

Tree schema = schema(element("foo"));
Tree document = tree("foo");
new XmlSchemaValidator(schema).validate(document);

You may also validate the schema itself against the XML Schema schema:

Tree schema = schema(element("foo"));
new XmlSchemaValidator(XmlSchema.XSD).validate(schema);

There are not yet helper methods for every XML Schema element and attribute. Maybe later. Create a pull request if you want to add something there.

Why yet another XML library?

We had to create lots of REST APIs for external consumption, but our customer did not allow us to use Clojure and JSON, but instead required us to use Java and XML, even producing XML Schemas. We tried to use JAXB for about two days. To protect our sanity and to save time, we created this library to have a succinct syntax for creating XML documents and schemas.

Version History

DataTree 1.0.0 (2014-03-11)

Changed XmlSchemaValidator to have only instance methods, to avoid confusion with the order of parameters. The XML sources are stateful, so you must create a new instance of the validator for every document
Added XmlVulnerabilities utility for checking whether an XML document may contain an XXE or DoS attack

DataTree 0.9.0 (2013-09-20)

Can validate the schema of schemas without the validator downloading the schemas for XML Schema and XML Namespaces from www.w3.org

DataTree 0.8.0 (2013-09-16)

tree and meta will accept any instances and convert them automatically to String using toString()

DataTree 0.7.0 (2013-09-16)

Added XmlGenerator.toByteArray()

DataTree 0.6.0 (2013-09-13)

Removed XmlDocumentGenerator.toXml()
Renamed XmlDocumentGenerator to XmlGenerator
Added XmlGenerator.toInputStream()
Added XmlGenerator.toString() and toPrettyString()
Added XmlGenerator.toNamespaceAwareDocument()
XmlGenerator.toDocument() won't anymore produce empty text nodes

DataTree 0.5.0 (2013-09-10)

tree() will flatten also Iterable arguments
In Tree.toString(), show meta before text

DataTree 0.4.0 (2013-09-10)

null in a tree's content does not anymore cause NullPointerException, but will be ignored silently. We consider null to be equivalent to an empty list, the same way as Clojure's nil
Will throw an IllegalArgumentException if trying to put something other than String, Tree or Meta instances into a tree

DataTree 0.3.0 (2013-09-10)

XmlSchema class with helper methods for generating XSD files

DataTree 0.2.0 (2013-09-09)

A tree node may now contain both text and meta data
tree() accepts arrays and collections of its arguments and will flatten them. This is useful when splitting tree construction into helper methods
Renamed Tree.content() to Tree.text()
Made the Meta class' constructor package-private to encourage using the Tree.meta() factory method

DataTree 0.1.0 (2013-09-08)

Can create a tree using succinct Java syntax
Can convert the tree into an XML document

luontola/datatree