org.trancecode.xml.saxon

Class SaxonBuilder

java.lang.Object

org.trancecode.xml.saxon.SaxonBuilder

public class SaxonBuilder
extends Object

A builder to create new XdmNode documents using a push API. It provides a facade to the lower-level Saxon Receiver API.

Author:

Romain Deltour

See Also:

Receiver

Constructor Summary

Constructors

Constructor and Description
SaxonBuilder(net.sf.saxon.Configuration configuration) Creates a new builder based on the given Saxon configuration.

Method Summary

Methods

Modifier and Type	Method and Description
void	attribute(net.sf.saxon.s9api.QName qname, String value) Adds an attribute to the current element.
void	comment(String comment) Adds a new comment node.
void	endDocument() Ends the document node.
void	endElement() Ends the current element node.
net.sf.saxon.s9api.XdmNode	getNode() Returns the result node built by this builder.
void	namespace(String prefix, String uri) Declares a new namespace in the current element
void	nodes(Iterable<net.sf.saxon.s9api.XdmNode> nodes) Appends the given nodes to the document being built.
void	nodes(net.sf.saxon.s9api.XdmNode... nodes) Appends the given nodes to the document being built.
void	processingInstruction(String name, String data) Adds a processing instruction.
void	raw(String raw, net.sf.saxon.s9api.Processor processor) Adds a raw XML fragment
void	startContent() Starts the content of the current element.
void	startDocument() Starts a document node.
void	startElement(net.sf.saxon.s9api.QName qname) Starts a new element with the given QName.
void	startElement(net.sf.saxon.s9api.QName qname, net.sf.saxon.s9api.XdmNode nsContext) Start a new element with the given QName, and adds the in-scope namespaces of the given node to the new element.
void	text(String text) Adds a text node

Methods inherited from class java.lang.Object

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

Constructor Detail

SaxonBuilder

public SaxonBuilder(net.sf.saxon.Configuration configuration)

Creates a new builder based on the given Saxon configuration.

Parameters:

configuration - The Saxon configuration. In particular, the name pool of the configuration will be used to construct the new item codes.

Method Detail

startDocument

public void startDocument()

Starts a document node.

endDocument

public void endDocument()

Ends the document node.

startElement

public void startElement(net.sf.saxon.s9api.QName qname)

Starts a new element with the given QName.

Parameters:

qname - The QName of the new element.

startElement

public void startElement(net.sf.saxon.s9api.QName qname,
                net.sf.saxon.s9api.XdmNode nsContext)

Start a new element with the given QName, and adds the in-scope namespaces of the given node to the new element.

Parameters:

qname - The QName of the new element.

nsContext - A node whose in-scope namespaces are copied to the new element.

endElement

public void endElement()

Ends the current element node.

startContent

public void startContent()

Starts the content of the current element. Must be called after the declaration of namespaces and attributes, before adding text or node children to the element.

attribute

public void attribute(net.sf.saxon.s9api.QName qname,
             String value)

Adds an attribute to the current element.

Parameters:

qname - The QName of the attribute

value - The value of the attribute

comment

public void comment(String comment)

Adds a new comment node.

Parameters:

comment - The comment text

namespace

public void namespace(String prefix,
             String uri)

Declares a new namespace in the current element

Parameters:

prefix - The namespace prefix

uri - The namespace URI

nodes

public void nodes(net.sf.saxon.s9api.XdmNode... nodes)

Appends the given nodes to the document being built.

nodes

public void nodes(Iterable<net.sf.saxon.s9api.XdmNode> nodes)

Appends the given nodes to the document being built.

processingInstruction

public void processingInstruction(String name,
                         String data)

Adds a processing instruction.

Parameters:

name - The processing instruction name

data - The processing instruction data

text

public void text(String text)

Adds a text node

Parameters:

text - The text content

raw

public void raw(String raw,
       net.sf.saxon.s9api.Processor processor)

Adds a raw XML fragment

Parameters:

raw - The XML fragment

getNode

public net.sf.saxon.s9api.XdmNode getNode()

Returns the result node built by this builder.