Class DocumentImpl

    • Field Detail

      • children

        protected java.lang.Object children
      • sequence

        protected int sequence
    • Constructor Detail

      • DocumentImpl

        public DocumentImpl()
        Create a DocumentImpl
    • Method Detail

      • setConfiguration

        public void setConfiguration​(Configuration config)
        Set the Configuration that contains this document
        Parameters:
        config - the Saxon configuration
      • setImaginary

        public void setImaginary​(boolean imaginary)
        Set whether this is an imaginary document node
        Parameters:
        imaginary - if true, this is an imaginary node - the tree is really rooted at the topmost element
      • isImaginary

        public boolean isImaginary()
        Ask whether this is an imaginary document node
        Returns:
        true if this is an imaginary node - the tree is really rooted at the topmost element
      • getDocumentNumber

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

        public void graftLocationMap​(DocumentImpl original)
        Copy the system ID and line number map from another document (used when grafting a simplified stylesheet)
        Parameters:
        original - the document whose system ID and line number maps are to be grafted onto this tree
      • setSystemId

        public void setSystemId​(java.lang.String uri)
        Set the system id (base URI) of this node
        Specified by:
        setSystemId in interface javax.xml.transform.Source
        Overrides:
        setSystemId in class NodeImpl
      • getSystemId

        public java.lang.String getSystemId()
        Get the system id of this root node
        Specified by:
        getSystemId in interface NodeInfo
        Specified by:
        getSystemId in interface javax.xml.transform.Source
        Specified by:
        getSystemId in interface javax.xml.transform.SourceLocator
        Overrides:
        getSystemId in class NodeImpl
        Returns:
        the System Identifier of the entity in the source document containing the node, or null if not known or not applicable.
      • setBaseURI

        public void setBaseURI​(java.lang.String uri)
        Set the base URI of this document node
        Parameters:
        uri - the new base URI
      • getBaseURI

        public java.lang.String getBaseURI()
        Get the base URI of this root node.
        Specified by:
        getBaseURI in interface NodeInfo
        Overrides:
        getBaseURI in class NodeImpl
        Returns:
        the base URI
      • setLineNumbering

        public void setLineNumbering()
        Set line numbering on
      • getLineNumber

        public int getLineNumber()
        Get the line number of this root node.
        Specified by:
        getLineNumber in interface NodeInfo
        Specified by:
        getLineNumber in interface javax.xml.transform.SourceLocator
        Overrides:
        getLineNumber in class NodeImpl
        Returns:
        0 always
      • getNodeKind

        public final int getNodeKind()
        Return the type of node.
        Specified by:
        getNodeKind in interface NodeInfo
        Returns:
        Type.DOCUMENT (always)
        See Also:
        Type
      • getDocumentElement

        public ElementImpl getDocumentElement()
        Get the root (outermost) element.
        Returns:
        the Element node for the outermost element of the document.
      • getRoot

        public NodeInfo getRoot()
        Get the root node
        Specified by:
        getRoot in interface NodeInfo
        Overrides:
        getRoot in class NodeImpl
        Returns:
        the NodeInfo representing the root of this tree
      • getPhysicalRoot

        public DocumentImpl getPhysicalRoot()
        Get the physical root of the tree. This may be an imaginary document node: this method should be used only when control information held at the physical root is required
        Overrides:
        getPhysicalRoot in class NodeImpl
        Returns:
        the document node, which may be imaginary
      • generateId

        public void generateId​(FastStringBuffer buffer)
        Get a character string that uniquely identifies this node
        Specified by:
        generateId in interface NodeInfo
        Overrides:
        generateId in class NodeImpl
        Parameters:
        buffer - a buffer into which will be placed a string based on the document number
      • deIndex

        public void deIndex​(NodeImpl node)
        Remove a node from any indexes when it is detached from the tree
        Parameters:
        node - the node to be removed from all indexes
      • registerID

        protected void registerID​(NodeInfo e,
                                  java.lang.String id)
        Register a unique element ID. Does nothing if there is already an element with that ID.
        Parameters:
        e - The Element having a particular unique ID value
        id - The unique ID value
      • selectID

        public NodeInfo selectID​(java.lang.String id)
        Get the element with a given ID.
        Specified by:
        selectID in interface DocumentInfo
        Parameters:
        id - The unique ID of the required element, previously registered using registerID()
        Returns:
        The NodeInfo for the given ID if one has been registered, otherwise null.
      • deregisterID

        protected void deregisterID​(java.lang.String id)
        Remove the entry for a given ID (when nodes are deleted). Does nothing if the id value is not present in the index.
        Parameters:
        id - The id value
      • getUnparsedEntityNames

        public java.util.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 java.lang.String[] getUnparsedEntity​(java.lang.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, return null. * @return the URI of the entity if there is one, or empty string if not
      • copy

        public void copy​(Receiver out,
                         int whichNamespaces,
                         boolean copyAnnotations,
                         int locationId)
                  throws XPathException
        Copy this node to a given outputter
        Specified by:
        copy in interface NodeInfo
        Parameters:
        out - the Receiver to which the node should be copied. It is the caller's responsibility to ensure that this Receiver is open before the method is called (or that it is self-opening), and that it is closed after use.
        whichNamespaces - in the case of an element, controls which namespace nodes should be copied. Values are NodeInfo.NO_NAMESPACES, NodeInfo.LOCAL_NAMESPACES, NodeInfo.ALL_NAMESPACES
        copyAnnotations - indicates whether the type annotations of element and attribute nodes should be copied
        locationId - If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information for the original node is to be copied; in this case the Receiver must be a LocationCopier
        Throws:
        XPathException
      • replaceStringValue

        public void replaceStringValue​(java.lang.CharSequence stringValue)
        Replace the string-value of this node
        Specified by:
        replaceStringValue in interface MutableNodeInfo
        Parameters:
        stringValue - the new string value
      • getSequenceNumber

        protected final long getSequenceNumber()
        Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and document nodes) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position. For nodes added by XQUery Update, the sequence number is -1L
        Overrides:
        getSequenceNumber in class NodeImpl
        Returns:
        the sequence number if there is one, or -1L otherwise.
      • hasChildNodes

        public final boolean hasChildNodes()
        Determine if the node has any children.
        Specified by:
        hasChildNodes in interface NodeInfo
        Overrides:
        hasChildNodes in class NodeImpl
        Returns:
        true if the node has any children, false if the node has no children.
      • getNumberOfChildren

        public int getNumberOfChildren()
        Determine how many children the node has
        Returns:
        the number of children of this parent node
      • enumerateChildren

        protected final AxisIterator enumerateChildren​(NodeTest test)
        Get an enumeration of the children of this node
        Parameters:
        test - A NodeTest to be satisfied by the child nodes, or null if all child node are to be returned
        Returns:
        an iterator over the children of this node
      • getFirstChild

        public final NodeInfo getFirstChild()
        Get the first child node of the element
        Overrides:
        getFirstChild in class NodeImpl
        Returns:
        the first child node of the required type, or null if there are no children
      • getLastChild

        public final NodeInfo getLastChild()
        Get the last child node of the element
        Overrides:
        getLastChild in class NodeImpl
        Returns:
        the last child of the element, or null if there are no children
      • getNthChild

        protected final NodeImpl getNthChild​(int n)
        Get the nth child node of the element (numbering from 0)
        Parameters:
        n - identifies the required child
        Returns:
        the last child of the element, or null if there is no n'th child
      • removeChild

        protected void removeChild​(NodeImpl child)
        Remove a given child
        Parameters:
        child - the child to be removed
      • getStringValue

        public java.lang.String getStringValue()
        Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
        Returns:
        the accumulated character content of the element, including descendant elements.
        See Also:
        Item.getStringValueCS()
      • useChildrenArray

        protected void useChildrenArray​(NodeImpl[] array)
        Supply an array to be used for the array of children. For system use only.
        Parameters:
        array - the array to be used
      • addChild

        public void addChild​(NodeImpl node,
                             int index)
        Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.
        Parameters:
        node - the node to be added as a child of this node
        index - the position where the child is to be added
      • insertChildren

        public void insertChildren​(NodeInfo[] source,
                                   boolean atStart,
                                   boolean inherit)
        Insert copies of a sequence of nodes as children of this node.

        This method takes no action unless the target node is a document node or element node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.

        The supplied nodes will be copied to form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed.

        Specified by:
        insertChildren in interface MutableNodeInfo
        Overrides:
        insertChildren in class NodeImpl
        Parameters:
        source - the nodes to be inserted
        atStart - true if the new nodes are to be inserted before existing children; false if they are
        inherit - true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children
      • insertChildrenAt

        protected void insertChildrenAt​(NodeInfo[] source,
                                        int index,
                                        boolean inherit)
        Insert children before or after a given existing child
        Parameters:
        source - the children to be inserted
        index - the position before which they are to be inserted: 0 indicates insertion before the first child, 1 insertion before the second child, and so on.
        inherit - true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children
      • replaceChildrenAt

        protected void replaceChildrenAt​(NodeInfo[] source,
                                         int index,
                                         boolean inherit)
        Replace child at a given index by new children
        Parameters:
        source - the children to be inserted
        index - the position at which they are to be inserted: 0 indicates replacement of the first child, replacement of the second child, and so on. The effect is undefined if index is out of range
        inherit - set to true if the new child elements are to inherit the in-scope namespaces of their new parent
        Throws:
        java.lang.IllegalArgumentException - if any of the replacement nodes is not an element, text, comment, or processing instruction node
      • compact

        public void compact​(int size)
        Compact the space used by this node
        Parameters:
        size - the number of actual children