Package com.saxonica.ee.domino
Class Erector
java.lang.Object
com.saxonica.ee.domino.Erector
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
FieldsFields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(UnicodeString chars, Location locationId, int properties) Notify a text nodevoid
close()
Notify the end of the event streamvoid
comment
(UnicodeString chars, Location locationId, int properties) Callback interface for SAX: not for application usevoid
Callback interface for SAX: not for application usevoid
Notify the end of an element nodeerect()
int
Get the current depth in the treeGet the last completed element node.Get the pipeline configurationGet the system identifier that was set with setSystemId.getTree()
Get the tree being built by this builderprotected int
makeTextNode
(UnicodeString chars) Create a text node.void
open()
Open the event streamvoid
processingInstruction
(String piname, UnicodeString remainder, Location locationId, int properties) Callback interface for SAX: not for application usevoid
reset()
void
Set the pipeline configurationvoid
setSystemId
(String systemId) Set the System ID of the tree represented by this event streamvoid
setUnparsedEntity
(String name, String uri, String publicId) Set an unparsed entity in the documentvoid
startDocument
(int properties) Write a document node to the treevoid
startElement
(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) Notify the start tag of an elementboolean
Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute eventsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.saxon.event.Receiver
append, append, handlesAppend
-
Field Details
-
PARENT_POINTER_INTERVAL
public static final int PARENT_POINTER_INTERVAL- See Also:
-
-
Constructor Details
-
Erector
-
-
Method Details
-
erect
- Throws:
XPathException
-
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 -
startDocument
Write a document node to the tree- Specified by:
startDocument
in interfaceReceiver
- Parameters:
properties
- any special properties of the node (none currently defined)- Throws:
XPathException
- if an error occurs
-
endDocument
Callback interface for SAX: not for application use- Specified by:
endDocument
in interfaceReceiver
- Throws:
XPathException
- if an error occurs
-
reset
public void reset() -
close
Description copied from interface:Receiver
Notify the end of the event stream- Specified by:
close
in interfaceReceiver
- Throws:
XPathException
- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException Notify the start tag of an element- Specified by:
startElement
in interfaceReceiver
- Parameters:
elemName
- the name of the element.type
- the type annotation of the element.attributes
- the attributes of this elementnamespaces
- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation
- an object providing information about the module, line, and column where the node originatedproperties
- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption
- Throws:
XPathException
- if an error occurs
-
endElement
Notify the end of an element node- Specified by:
endElement
in interfaceReceiver
- Throws:
XPathException
- if an error occurs
-
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(UnicodeString chars, Location locationId, int properties) throws XPathException Notify a text node- Specified by:
characters
in interfaceReceiver
- Parameters:
chars
- The characterslocationId
- 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
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- Returns:
- the node number of the created text node, or the text node to which this text has been appended.
-
processingInstruction
public void processingInstruction(String piname, UnicodeString remainder, Location locationId, int properties) throws XPathException Callback interface for SAX: not for application use- Specified by:
processingInstruction
in interfaceReceiver
- Parameters:
piname
- The PI name. This must be a legal name (it will not be checked).remainder
- The data portion of the processing instructionlocationId
- provides information such as line number and system ID.properties
- Additional information about the PI.- Throws:
XPathException
- if an error occurs
-
comment
Callback interface for SAX: not for application use- Specified by:
comment
in interfaceReceiver
- Parameters:
chars
- The content of the commentlocationId
- provides information such as line number and system ID.properties
- Additional information about the comment.- Throws:
XPathException
- if an error occurs
-
setUnparsedEntity
Set an unparsed entity in the document- Specified by:
setUnparsedEntity
in interfaceReceiver
- Parameters:
name
- The name of the unparsed entityuri
- The system identifier of the unparsed entitypublicId
- The identifier of the unparsed entity
-
getPipelineConfiguration
Get the pipeline configuration- Specified by:
getPipelineConfiguration
in interfaceReceiver
- Returns:
- the pipeline configuration
-
setPipelineConfiguration
Set the pipeline configuration- Specified by:
setPipelineConfiguration
in interfaceReceiver
- Parameters:
pipe
- the pipeline configuration
-
setSystemId
Set the System ID of the tree represented by this event stream- Specified by:
setSystemId
in interfaceResult
- 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 interfaceReceiver
- 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
Get the system identifier that was set with setSystemId.- Specified by:
getSystemId
in interfaceResult
- Returns:
- The system identifier that was set with setSystemId, or null if setSystemId was not called.
-