Package com.saxonica.ee.domino
Class Erector
- java.lang.Object
-
- com.saxonica.ee.domino.Erector
-
-
Field Summary
Fields Modifier and Type Field Description static intPARENT_POINTER_INTERVAL
-
Constructor Summary
Constructors Constructor Description Erector(org.w3c.dom.Document doc, java.lang.String systemId, Configuration config)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Notify a text nodevoidclose()Notify the end of the event streamvoidcomment(java.lang.CharSequence chars, Location locationId, int properties)Callback interface for SAX: not for application usevoidendDocument()Callback interface for SAX: not for application usevoidendElement()Notify the end of an element nodeDominoTreeerect()intgetCurrentDepth()Get the current depth in the treeDominoNodegetLastCompletedElement()Get the last completed element node.PipelineConfigurationgetPipelineConfiguration()Get the pipeline configurationjava.lang.StringgetSystemId()Get the system identifier that was set with setSystemId.DominoTreegetTree()Get the tree being built by this builderprotected intmakeTextNode(java.lang.CharSequence chars, int len)Create a text node.voidopen()Open the event streamvoidprocessingInstruction(java.lang.String piname, java.lang.CharSequence remainder, Location locationId, int properties)Callback interface for SAX: not for application usevoidreset()voidsetPipelineConfiguration(PipelineConfiguration pipe)Set the pipeline configurationvoidsetSystemId(java.lang.String systemId)Set the System ID of the tree represented by this event streamvoidsetUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)Set an unparsed entity in the documentvoidstartDocument(int properties)Write a document node to the treevoidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start tag of an elementbooleanusesTypeAnnotations()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
-
Methods inherited from interface net.sf.saxon.event.Receiver
append, append, handlesAppend
-
-
-
-
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
-
startDocument
public void startDocument(int properties) throws XPathExceptionWrite a document node to the tree- Specified by:
startDocumentin interfaceReceiver- Parameters:
properties-- Throws:
XPathException- if an error occurs
-
endDocument
public void endDocument() throws XPathExceptionCallback interface for SAX: not for application use- Specified by:
endDocumentin interfaceReceiver- Throws:
XPathException- if an error occurs
-
reset
public void reset()
-
close
public void close() throws XPathExceptionDescription copied from interface:ReceiverNotify the end of the event stream- Specified by:
closein 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:
startElementin 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
public void endElement() throws XPathExceptionNotify the end of an element node- Specified by:
endElementin interfaceReceiver- 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 XPathExceptionNotify a text node- Specified by:
charactersin 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
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 nodelen- 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 XPathExceptionCallback interface for SAX: not for application use- Specified by:
processingInstructionin 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
public void comment(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionCallback interface for SAX: not for application use- Specified by:
commentin 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
public void setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)Set an unparsed entity in the document- Specified by:
setUnparsedEntityin interfaceReceiver- Parameters:
name- The name of the unparsed entityuri- The system identifier of the unparsed entitypublicId- The identifier of the unparsed entity
-
getPipelineConfiguration
public PipelineConfiguration getPipelineConfiguration()
Get the pipeline configuration- Specified by:
getPipelineConfigurationin interfaceReceiver- Returns:
- the pipeline configuration
-
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipeline configuration- Specified by:
setPipelineConfigurationin interfaceReceiver- 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:
setSystemIdin interfaceReceiver- Specified by:
setSystemIdin interfacejavax.xml.transform.Result- 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:
usesTypeAnnotationsin 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
public java.lang.String getSystemId()
Get the system identifier that was set with setSystemId.- Specified by:
getSystemIdin interfacejavax.xml.transform.Result- Returns:
- The system identifier that was set with setSystemId, or null if setSystemId was not called.
-
-