Package net.sf.saxon.dom

Class DocumentWrapper

java.lang.Object
net.sf.saxon.dom.NodeWrapper
net.sf.saxon.dom.DocumentWrapper
All Implemented Interfaces:
Source, PullEvent, DocumentInfo, Item, NodeInfo, SiblingCountingNode, ValueRepresentation, VirtualNode
public class DocumentWrapper extends NodeWrapper implements DocumentInfo
The document node of a tree implemented as a wrapper around a DOM Document.

  • Field Details

    • config

      protected Configuration config

    • baseURI

      protected String baseURI

    • documentNumber

      protected int documentNumber

    • domLevel3

      protected boolean domLevel3

  • Constructor Details

    • DocumentWrapper

      public DocumentWrapper(Node doc, String baseURI, Configuration config)
      Wrap a DOM Document or DocumentFragment node
      Parameters:
      doc - a DOM Document or DocumentFragment node
      baseURI - the base URI of the document
      config - the Saxon configuration

  • Method Details

    • wrap

      public NodeWrapper wrap(Node node)
      Create a wrapper for a node in this document
      Parameters:
      node - the DOM node to be wrapped. This must be a node within the document wrapped by this DocumentWrapper
      Throws:
      IllegalArgumentException - if the node is not a descendant of the Document node wrapped by this DocumentWrapper

    • setConfiguration

      public void setConfiguration(Configuration config)
      Set the Configuration that contains this document

    • getConfiguration

      public Configuration getConfiguration()
      Get the configuration previously set using setConfiguration
      Specified by:
      getConfiguration in interface NodeInfo
      Overrides:
      getConfiguration in class NodeWrapper
      Returns:
      the Configuration

    • getNamePool

      public NamePool getNamePool()
      Get the name pool used for the names in this document
      Specified by:
      getNamePool in interface NodeInfo
      Overrides:
      getNamePool in class NodeWrapper
      Returns:
      the NamePool

    • getDocumentNumber

      public int getDocumentNumber()
      Get the unique document number
      Specified by:
      getDocumentNumber in interface NodeInfo
      Overrides:
      getDocumentNumber in class NodeWrapper
      Returns:
      the document number of the document containing this node

    • selectID

      public NodeInfo selectID(String id)
      Get the element with a given ID, if any
      Specified by:
      selectID in interface DocumentInfo
      Parameters:
      id - the required ID value
      Returns:
      a NodeInfo representing the element with the given ID, or null if there is no such element. This implementation does not necessarily conform to the rule that if an invalid document contains two elements with the same ID, the one that comes last should be returned.

    • isSameNodeInfo

      public boolean isSameNodeInfo(NodeInfo other)
      Determine whether this is the same node as another node.
      Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
      Specified by:
      isSameNodeInfo in interface NodeInfo
      Overrides:
      isSameNodeInfo in class NodeWrapper
      Parameters:
      other - the node to be compared with this node
      Returns:
      true if this Node object and the supplied Node object represent the same node in the tree.

    • getUnparsedEntityNames

      public Iterator getUnparsedEntityNames()
      Get the list of unparsed entities defined in this document
      Specified by:
      getUnparsedEntityNames in interface DocumentInfo
      Returns:
      an Iterator, whose items are of type String, containing the names of all unparsed entities defined in this document. If there are no unparsed entities or if the information is not available then an empty iterator is returned

    • getUnparsedEntity

      public String[] getUnparsedEntity(String name)
      Get the unparsed entity with a given name
      Specified by:
      getUnparsedEntity in interface DocumentInfo
      Parameters:
      name - the name of the entity
      Returns:
      null: JDOM does not provide access to unparsed entities