com.saxonica.ee.domino

Class Erector

java.lang.Object

com.saxonica.ee.domino.Erector

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class Erector
extends java.lang.Object
implements Receiver

This class is instantiated to build a DOMINO tree, taking a DOM Document as input; its task is to add the indexing information.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PARENT_POINTER_INTERVAL

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor and Description
Erector(org.w3c.dom.Document doc, java.lang.String systemId, Configuration config)

Method Summary

Modifier and Type	Method and Description
void	attribute(NodeName attName, SimpleType type, java.lang.CharSequence value, Location locationId, int properties) Notify an attribute.
void	characters(java.lang.CharSequence chars, Location locationId, int properties) Notify a text node
void	close() Notify the end of the event stream
void	comment(java.lang.CharSequence chars, Location locationId, int properties) Callback interface for SAX: not for application use
void	endDocument() Callback interface for SAX: not for application use
void	endElement() Notify the end of an element node
DominoTree	erect()
int	getCurrentDepth() Get the current depth in the tree
DominoNode	getLastCompletedElement() Get the last completed element node.
PipelineConfiguration	getPipelineConfiguration() Get the pipeline configuration
java.lang.String	getSystemId() Get the system identifier that was set with setSystemId.
DominoTree	getTree() Get the tree being built by this builder
protected int	makeTextNode(java.lang.CharSequence chars, int len) Create a text node.
void	namespace(NamespaceBindingSet namespaceBindings, int properties) Notify one or more namespaces.
void	open() Open the event stream
void	processingInstruction(java.lang.String piname, java.lang.CharSequence remainder, Location locationId, int properties) Callback interface for SAX: not for application use
void	reset()
void	setPipelineConfiguration(PipelineConfiguration pipe) Set the pipeline configuration
void	setSystemId(java.lang.String systemId) Set the System ID of the tree represented by this event stream
void	setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId) Set an unparsed entity in the document
void	startContent() Notify the start of the content, that is, the completion of all attributes and namespaces.
void	startDocument(int properties) Write a document node to the tree
void	startElement(NodeName elemName, SchemaType type, Location location, int properties) Notify the start tag of an element
boolean	usesTypeAnnotations() Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Methods inherited from class java.lang.Object

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

Field Detail

PARENT_POINTER_INTERVAL

public static final int PARENT_POINTER_INTERVAL

See Also:

Constant Field Values

Constructor Detail

Erector

public Erector(org.w3c.dom.Document doc,
               java.lang.String systemId,
               Configuration config)

Method Detail

erect

public DominoTree erect()
                 throws XPathException

Throws:

XPathException

getTree

public DominoTree getTree()

Get the tree being built by this builder

Returns:

the TinyTree

getCurrentDepth

public int getCurrentDepth()

Get the current depth in the tree

Returns:

the current depth

open

public void open()

Open the event stream

Specified by:

open in interface Receiver

startDocument

public void startDocument(int properties)
                   throws XPathException

Write a document node to the tree

Specified by:

startDocument in interface Receiver

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions

Throws:

XPathException - if an error occurs

endDocument

public void endDocument()
                 throws XPathException

Callback interface for SAX: not for application use

Specified by:

endDocument in interface Receiver

Throws:

XPathException - if an error occurs

reset

public void reset()

close

public void close()
           throws XPathException

Description copied from interface: Receiver

Notify the end of the event stream

Specified by:

close in interface Receiver

Throws:

XPathException - if an error occurs

startElement

public void startElement(NodeName elemName,
                         SchemaType type,
                         Location location,
                         int properties)
                  throws XPathException

Notify the start tag of an element

Specified by:

startElement in interface Receiver

Parameters:

elemName - the name of the element.

type - the type annotation of the element.

location - an object providing information about the module, line, and column where the node originated

properties - bit-significant properties of the element node. If there are no revelant properties, zero is supplied. The definitions of the bits are in class ReceiverOptions

Throws:

XPathException - if an error occurs

namespace

public void namespace(NamespaceBindingSet namespaceBindings,
                      int properties)
               throws XPathException

Description copied from interface: Receiver

Notify one or more namespaces. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element. The events represent namespace declarations and undeclarations rather than in-scope namespace nodes: an undeclaration is represented by a namespace code of zero. If the sequence of namespace events contains two A namespace must not conflict with any namespaces already used for element or attribute names.

Specified by:

namespace in interface Receiver

Parameters:

namespaceBindings - contains the namespace prefix and namespace URI

properties - The most important property is REJECT_DUPLICATES. If this property is set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:

Throws:

XPathException - if an error occurs

attribute

public void attribute(NodeName attName,
                      SimpleType type,
                      java.lang.CharSequence value,
                      Location locationId,
                      int properties)
               throws XPathException

Description copied from interface: Receiver

Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.

Specified by:

attribute in interface Receiver

Parameters:

attName - The name of the attribute

type - The type annotation of the attribute

value - the string value of the attribute

locationId - provides information such as line number and system ID.

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this attribute

NO_SPECIAL_CHARACTERS

Attribute value contains no special characters

Throws:

XPathException - if an error occurs

startContent

public void startContent()

Description copied from interface: Receiver

Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.

Specified by:

startContent in interface Receiver

endElement

public void endElement()
                throws XPathException

Notify the end of an element node

Specified by:

endElement in interface Receiver

Throws:

XPathException - if an error occurs

getLastCompletedElement

public DominoNode getLastCompletedElement()

Get the last completed element node. This is used during checking of schema assertions, which happens while the tree is still under construction. It is also used when copying accumulator values to the new tree from a streamed input. This method is called immediately after a call on endElement(), and it returns the element that has just ended.

Returns:

the last completed element node, that is, the element whose endElement event is the most recent endElement event to be reported, or null if there is no such element

characters

public void characters(java.lang.CharSequence chars,
                       Location locationId,
                       int properties)
                throws XPathException

Notify a text node

Specified by:

characters in interface Receiver

Parameters:

chars - The characters

locationId - provides information such as line number and system ID.

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

Throws:

XPathException - if an error occurs

makeTextNode

protected int makeTextNode(java.lang.CharSequence chars,
                           int len)

Create a text node. Separate method so it can be overridden. If the current node on the tree is already a text node, the new text will be appended to it.

Parameters:

chars - the contents of the text node

len - the length of the text node

Returns:

the node number of the created text node, or the text node to which this text has been appended.

processingInstruction

public void processingInstruction(java.lang.String piname,
                                  java.lang.CharSequence remainder,
                                  Location locationId,
                                  int properties)
                           throws XPathException

Callback interface for SAX: not for application use

Specified by:

processingInstruction in interface Receiver

Parameters:

piname - The PI name. This must be a legal name (it will not be checked).

remainder - The data portion of the processing instruction

locationId - provides information such as line number and system ID.

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

comment

public void comment(java.lang.CharSequence chars,
                    Location locationId,
                    int properties)
             throws XPathException

Callback interface for SAX: not for application use

Specified by:

comment in interface Receiver

Parameters:

chars - The content of the comment

locationId - provides information such as line number and system ID.

properties - Additional information about the comment.

Throws:

XPathException - if an error occurs

setUnparsedEntity

public void setUnparsedEntity(java.lang.String name,
                              java.lang.String uri,
                              java.lang.String publicId)

Set an unparsed entity in the document

Specified by:

setUnparsedEntity in interface Receiver

Parameters:

name - The name of the unparsed entity

uri - The system identifier of the unparsed entity

publicId - The identifier of the unparsed entity

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()

Get the pipeline configuration

Specified by:

getPipelineConfiguration in interface Receiver

Returns:

the pipeline configuration

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

Set the pipeline configuration

Specified by:

setPipelineConfiguration in interface Receiver

Parameters:

pipe - the pipeline configuration

setSystemId

public void setSystemId(java.lang.String systemId)

Set the System ID of the tree represented by this event stream

Specified by:

setSystemId in interface javax.xml.transform.Result

Specified by:

setSystemId in interface Receiver

Parameters:

systemId - the system ID (which is used as the base URI of the nodes if there is no xml:base attribute)

usesTypeAnnotations

public boolean usesTypeAnnotations()

Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Specified by:

usesTypeAnnotations in interface Receiver

Returns:

true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation (or conversely, it may avoid stripping unwanted type annotations)

getSystemId

public java.lang.String getSystemId()

Get the system identifier that was set with setSystemId.

Specified by:

getSystemId in interface javax.xml.transform.Result

Returns:

The system identifier that was set with setSystemId, or null if setSystemId was not called.