Package net.sf.saxon.dom

Class DOMWriter

java.lang.Object
net.sf.saxon.event.Builder
net.sf.saxon.dom.DOMWriter
All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
DominoTreeModel.DominoBuilder
public class DOMWriter extends Builder
DOMWriter is a Receiver that attaches the result tree to a specified Node in the DOM Document

  • Constructor Details

    • DOMWriter

      public DOMWriter()

  • Method Details

    • setPipelineConfiguration

      public void setPipelineConfiguration(PipelineConfiguration pipe)
      Set the pipelineConfiguration
      Specified by:
      setPipelineConfiguration in interface Receiver
      Overrides:
      setPipelineConfiguration in class Builder
      Parameters:
      pipe - the pipeline configuration

    • getPipelineConfiguration

      public PipelineConfiguration getPipelineConfiguration()
      Get the pipeline configuration used for this document
      Specified by:
      getPipelineConfiguration in interface Receiver
      Overrides:
      getPipelineConfiguration in class Builder
      Returns:
      the pipeline configuration

    • setSystemId

      public void setSystemId(String systemId)
      Set the System ID of the destination tree
      Specified by:
      setSystemId in interface Result
      Overrides:
      setSystemId in class Builder
      Parameters:
      systemId - the SystemId, that is, the document-uri.

    • setUnparsedEntity

      public void setUnparsedEntity(String name, String systemID, String publicID) throws XPathException
      Notify an unparsed entity URI.
      Parameters:
      name - The name of the unparsed entity
      systemID - The system identifier of the unparsed entity
      publicID - The public identifier of the unparsed entity
      Throws:
      XPathException - if an error occurs

    • getSystemId

      public String getSystemId()
      Get the system identifier that was set with setSystemId.
      Specified by:
      getSystemId in interface Result
      Overrides:
      getSystemId in class Builder
      Returns:
      The system identifier that was set with setSystemId, or null if setSystemId was not called.

    • open

      public void open()
      Start of the document.
      Specified by:
      open in interface Receiver
      Overrides:
      open in class Builder

    • close

      public void close()
      End of the document.
      Specified by:
      close in interface Receiver
      Overrides:
      close in class Builder

    • startDocument

      public void startDocument(int properties) throws XPathException
      Start of a document node.
      Parameters:
      properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption
      Throws:
      XPathException - if an error occurs

    • endDocument

      public void endDocument() throws XPathException
      Notify the end of a document node
      Throws:
      XPathException - if an error occurs

    • startElement

      public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
      Start of an element.
      Parameters:
      elemName - the name of the element.
      type - the type annotation of the element.
      attributes - the attributes of this element
      namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
      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 relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption
      Throws:
      XPathException - if an error occurs

    • endElement

      public void endElement() throws XPathException
      End of an element.
      Throws:
      XPathException - if an error occurs

    • characters

      public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException
      Character data.
      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

    • processingInstruction

      public void processingInstruction(String target, UnicodeString data, Location locationId, int properties) throws XPathException
      Handle a processing instruction.
      Parameters:
      target - The PI name. This must be a legal name (it will not be checked).
      data - 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(UnicodeString chars, Location locationId, int properties) throws XPathException
      Handle a comment.
      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

    • 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
      Overrides:
      usesTypeAnnotations in class Builder
      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

    • setNode

      public void setNode(Node node)
      Set the attachment point for the new subtree
      Parameters:
      node - the node to which the new subtree will be attached

    • setNextSibling

      public void setNextSibling(Node nextSibling)
      Set next sibling
      Parameters:
      nextSibling - the node, which must be a child of the attachment point, before which the new subtree will be created. If this is null the new subtree will be added after any existing children of the attachment point.

    • 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.
      Overrides:
      getCurrentRoot in class Builder
      Returns:
      the root of the tree that is currently being built, or that has been most recently built using this builder

    • getDOMDocumentNode

      protected Document getDOMDocumentNode()
      Get the constructed DOM Document node
      Returns:
      the DOM Document node