Class UnconstructedDocument

java.lang.Object
net.sf.saxon.pull.UnconstructedParent
net.sf.saxon.pull.UnconstructedDocument
All Implemented Interfaces:
Source, DocumentInfo, Item, NodeInfo, ValueRepresentation

public class UnconstructedDocument extends UnconstructedParent implements DocumentInfo
A document node whose construction is deferred.

(TODO) NOTE: this class is an exception to the general rule that for document nodes, node identity implies object identity
  • Constructor Details

  • Method Details

    • getNameCode

      public int getNameCode()
      Get name code. The name code is a coded form of the node name: two nodes with the same name code have the same namespace URI, the same local name, and the same prefix. By masking the name code with invalid input: '&'0xfffff, you get a fingerprint: two nodes with the same fingerprint have the same local name and namespace URI.
      Specified by:
      getNameCode in interface NodeInfo
      Returns:
      an integer name code, which may be used to obtain the actual node name from the name pool
      See Also:
    • getNodeKind

      public int getNodeKind()
      Description copied from interface: NodeInfo
      Get the kind of node. This will be a value such as Type.ELEMENT or Type.ATTRIBUTE. There are seven kinds of node: documents, elements, attributes, text, comments, processing-instructions, and namespaces.
      Specified by:
      getNodeKind in interface NodeInfo
      Returns:
      an integer identifying the kind of node. These integer values are the same as those used in the DOM
      See Also:
    • getFingerprint

      public int getFingerprint()
      Get fingerprint. The fingerprint is a coded form of the expanded name of the node: two nodes with the same name code have the same namespace URI and the same local name. A fingerprint of -1 should be returned for a node with no name.
      Specified by:
      getFingerprint in interface NodeInfo
      Overrides:
      getFingerprint in class UnconstructedParent
      Returns:
      an integer fingerprint; two nodes with the same fingerprint have the same expanded QName
    • getLocalPart

      public String getLocalPart()
      Get the local part of the name of this node. This is the name after the ":" if any.
      Specified by:
      getLocalPart in interface NodeInfo
      Overrides:
      getLocalPart in class UnconstructedParent
      Returns:
      the local part of the name. For an unnamed node, returns "". Unlike the DOM interface, this returns the full name in the case of a non-namespaced name.
    • getURI

      public String getURI()
      Get the URI part of the name of this node. This is the URI corresponding to the prefix, or the URI of the default namespace if appropriate.
      Specified by:
      getURI in interface NodeInfo
      Overrides:
      getURI in class UnconstructedParent
      Returns:
      The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.
    • getDisplayName

      public String getDisplayName()
      Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.
      Specified by:
      getDisplayName in interface NodeInfo
      Overrides:
      getDisplayName in class UnconstructedParent
      Returns:
      The display name of this node. For a node with no name, return an empty string.
    • getPrefix

      public String getPrefix()
      Get the prefix of the name of the node. This is defined only for elements and attributes. If the node has no prefix, or for other kinds of node, return a zero-length string.
      Specified by:
      getPrefix in interface NodeInfo
      Overrides:
      getPrefix in class UnconstructedParent
      Returns:
      The prefix of the name of the node.
    • getBaseURI

      public String getBaseURI()
      Description copied from class: UnconstructedParent
      Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node. This will be the same as the System ID unless xml:base has been used.
      Specified by:
      getBaseURI in interface NodeInfo
      Overrides:
      getBaseURI in class UnconstructedParent
      Returns:
      the base URI of the node
    • getDocumentRoot

      public DocumentInfo getDocumentRoot()
      Get the root node, if it is a document node.
      Specified by:
      getDocumentRoot in interface NodeInfo
      Overrides:
      getDocumentRoot in class UnconstructedParent
      Returns:
      the DocumentInfo representing the containing document. If this node is part of a tree that does not have a document node as its root, return null.
    • 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:
      the element with the given ID, or null if there is no such ID present (or if the parser has not notified attributes as being of type ID)
      Since:
      8.4
    • 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:
      if the entity exists, return an array of two Strings, the first holding the system ID of the entity, the second holding the public ID if there is one, or null if not. If the entity does not exist, the method returns null. Applications should be written on the assumption that this array may be extended in the future to provide additional information.
      Since:
      8.4