net.sf.saxon.event

Class Builder

public abstract class Builder extends Object implements Receiver

The abstract Builder class is responsible for taking a stream of SAX events and constructing a Document tree. There is one concrete subclass for each tree implementation.

Author: Michael H. Kay

Field Summary
protected Configuration	config
protected NodeInfo	currentRoot
protected boolean	lineNumbering
static int	LINKED_TREE Constant denoting the "linked tree" in which each node is represented as an object
protected NamePool	namePool
protected PipelineConfiguration	pipe
protected boolean	started
protected String	systemId
static int	STANDARD_TREE Alternative constant denoting the "linked tree" in which each node is represented as an object Retained for backwards compatibility
protected boolean	timing
static int	TINY_TREE Constant denoting the "tiny tree" in which the tree is represented internally using arrays of integers

Constructor Summary
	Builder() create a Builder and initialise variables

Method Summary
static NodeInfo	build(Source source, Stripper stripper, Configuration config) Static method to build a document from any kind of Source object.
static NodeInfo	build(Source source, Stripper stripper, PipelineConfiguration pipe) Static method to build a document from any kind of Source object.
void	close()
void	endDocument() Notify the end of a document node
Configuration	getConfiguration()
NodeInfo	getCurrentRoot() Get the current root node.
PipelineConfiguration	getPipelineConfiguration()
String	getSystemId()
boolean	isTiming() Get timing option
void	open()
void	setLineNumbering(boolean is)
void	setPipelineConfiguration(PipelineConfiguration pipe)
void	setSystemId(String systemId)
void	setTiming(boolean on) Set timing option on or off
void	startDocument(int properties) Start of a document node.

Field Detail

config

protected Configuration config

currentRoot

protected NodeInfo currentRoot

lineNumbering

protected boolean lineNumbering

LINKED_TREE

public static final int LINKED_TREE

Constant denoting the "linked tree" in which each node is represented as an object

namePool

protected NamePool namePool

pipe

protected PipelineConfiguration pipe

started

protected boolean started

systemId

protected String systemId

STANDARD_TREE

public static final int STANDARD_TREE

Alternative constant denoting the "linked tree" in which each node is represented as an object Retained for backwards compatibility

timing

protected boolean timing

TINY_TREE

public static final int TINY_TREE

Constant denoting the "tiny tree" in which the tree is represented internally using arrays of integers

Constructor Detail

Builder

public Builder()

create a Builder and initialise variables

Method Detail

build

public static NodeInfo build(Source source, Stripper stripper, Configuration config)

Static method to build a document from any kind of Source object. If the source is already in the form of a tree, it is wrapped as required.

Parameters: source Any javax.xml.transform.Source object stripper A stripper object, if whitespace text nodes are to be stripped; otherwise null. config The Configuration object

Returns: the NodeInfo of the start node in the resulting document object.

build

public static NodeInfo build(Source source, Stripper stripper, PipelineConfiguration pipe)

Static method to build a document from any kind of Source object. If the source is already in the form of a tree, it is wrapped as required.

Parameters: source Any javax.xml.transform.Source object stripper A stripper object, if whitespace text nodes are to be stripped; otherwise null. pipe The PipelineConfiguration object

Returns: the NodeInfo of the start node in the resulting document object.

close

public void close()

endDocument

public void endDocument()

Notify the end of a document node

getConfiguration

public Configuration getConfiguration()

getCurrentRoot

public NodeInfo getCurrentRoot()

Get the current root node. This will normally be a document node, but if the root of the tree is an element node, it can be an element.

Returns: the root of the tree that is currently being built, or that has been most recently built using this builder