Class DOMWriter

java.lang.Object
net.sf.saxon.dom.DOMWriter
All Implemented Interfaces:
Result, Receiver

public class DOMWriter extends Object implements Receiver
DOMWriter is a Receiver that attaches the result tree to a specified Node in a DOM Document
  • Constructor Details

    • DOMWriter

      public DOMWriter()
  • Method Details

    • setPipelineConfiguration

      public void setPipelineConfiguration(PipelineConfiguration pipe)
      Set the pipelineConfiguration
      Specified by:
      setPipelineConfiguration in interface Receiver
    • getPipelineConfiguration

      public PipelineConfiguration getPipelineConfiguration()
      Get the pipeline configuration used for this document
      Specified by:
      getPipelineConfiguration in interface Receiver
    • setSystemId

      public void setSystemId(String systemId)
      Set the System ID of the destination tree
      Specified by:
      setSystemId in interface Receiver
      Specified by:
      setSystemId in interface Result
    • setUnparsedEntity

      public void setUnparsedEntity(String name, String systemID, String publicID) throws XPathException
      Notify an unparsed entity URI.
      Specified by:
      setUnparsedEntity in interface Receiver
      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
    • getSystemId

      public String getSystemId()
      Get the system identifier that was set with setSystemId.
      Specified by:
      getSystemId in interface Result
      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
    • close

      public void close()
      End of the document.
      Specified by:
      close in interface Receiver
    • startDocument

      public void startDocument(int properties) throws XPathException
      Start of a document node.
      Specified by:
      startDocument in interface Receiver
      Throws:
      XPathException
    • endDocument

      public void endDocument() throws XPathException
      Notify the end of a document node
      Specified by:
      endDocument in interface Receiver
      Throws:
      XPathException
    • startElement

      public void startElement(int nameCode, int typeCode, int locationId, int properties) throws XPathException
      Start of an element.
      Specified by:
      startElement in interface Receiver
      Parameters:
      nameCode - integer code identifying the name of the element within the name pool.
      typeCode - integer code identifying the element's type within the name pool. The value -1 indicates the default type, xdt:untyped.
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - bit-significant properties of the element node. If there are no revelant properties, zero is supplied.
      Throws:
      XPathException
    • namespace

      public void namespace(int namespaceCode, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify a namespace. 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:
      namespaceCode - an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.
      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: it sets the REJECT_DUPLICATES flag, and this is treated as a hard error.
      Throws:
      XPathException
    • attribute

      public void attribute(int nameCode, int typeCode, CharSequence value, int 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:
      nameCode - The name of the attribute, as held in the name pool
      typeCode - The type of the attribute, as held in the name pool. The additional bit NodeInfo.IS_DTD_TYPE may be set to indicate a DTD-derived type.
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      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
    • startContent

      public void startContent() throws XPathException
      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
      Throws:
      XPathException
    • endElement

      public void endElement() throws XPathException
      End of an element.
      Specified by:
      endElement in interface Receiver
      Throws:
      XPathException
    • characters

      public void characters(CharSequence chars, int locationId, int properties) throws XPathException
      Character data.
      Specified by:
      characters in interface Receiver
      Parameters:
      chars - The characters
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - Bit significant value. The following bits are defined:
      DISABLE_ESCAPING
      Disable escaping for this text node
      USE_CDATA
      Output as a CDATA section
      NO_SPECIAL_CHARACTERS
      Value contains no special characters
      WHITESPACE
      Text is all whitespace
      Throws:
      XPathException
    • processingInstruction

      public void processingInstruction(String target, CharSequence data, int locationId, int properties) throws XPathException
      Handle a processing instruction.
      Specified by:
      processingInstruction in interface Receiver
      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 - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - Additional information about the PI. The following bits are defined:
      CHECKED
      Data is known to be legal (e.g. doesn't contain "?>")
      Throws:
      XPathException
    • comment

      public void comment(CharSequence chars, int locationId, int properties) throws XPathException
      Handle a comment.
      Specified by:
      comment in interface Receiver
      Parameters:
      chars - The content of the comment
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - Additional information about the comment. The following bits are defined:
      CHECKED
      Comment is known to be legal (e.g. doesn't contain "--")
      Throws:
      XPathException
    • setNode

      public void setNode(Node node)
      Set output destination