Class XOMDocumentWrapper

    • Field Detail

      • documentNumber

        protected long documentNumber
    • Constructor Detail

      • XOMDocumentWrapper

        public XOMDocumentWrapper​(nu.xom.Node root,
                                  Configuration config)
        Create a Saxon wrapper for a XOM root node
        Parameters:
        root - The XOM root node
        config - The configuration which defines the name pool used for all names in this tree
    • Method Detail

      • getRootNode

        public NodeInfo getRootNode()
        Get the NodeInfo object representing the document node at the root of the tree
        Specified by:
        getRootNode in interface TreeInfo
        Returns:
        the document node
      • wrap

        public NodeInfo wrap​(nu.xom.Node node)
        Wrap a node in the XOM document.
        Parameters:
        node - The node to be wrapped. This must be a node in the same document (the system does not check for this).
        Returns:
        the wrapping NodeInfo object
      • setConfiguration

        public void setConfiguration​(Configuration config)
        Set the configuration, which defines the name pool used for all names in this document. This is always called after a new document has been created. The implementation must register the name pool with the document, so that it can be retrieved using getNamePool(). It must also call NamePool.allocateDocumentNumber(), and return the relevant document number when getDocumentNumber() is subsequently called.
        Parameters:
        config - The configuration to be used
      • getNamePool

        public NamePool getNamePool()
        Get the name pool used for the names in this document
        Overrides:
        getNamePool in class XOMNodeWrapper
        Returns:
        the name pool in which all the names used in this document are registered
      • setSystemId

        public void setSystemId​(java.lang.String uri)
        Description copied from class: AbstractNodeWrapper
        Set the system ID. Required because NodeInfo implements the JAXP Source interface
        Specified by:
        setSystemId in interface NodeInfo
        Specified by:
        setSystemId in interface javax.xml.transform.Source
        Overrides:
        setSystemId in class AbstractNodeWrapper
        Parameters:
        uri - the system ID.
      • getDocumentNumber

        public long getDocumentNumber()
        Get the unique document number for this document (the number is unique for all documents within a NamePool)
        Specified by:
        getDocumentNumber in interface TreeInfo
        Returns:
        the unique number identifying this document within the name pool
      • selectID

        public NodeInfo selectID​(java.lang.String id,
                                 boolean getParent)
        Get the element with a given ID, if any
        Specified by:
        selectID in interface TreeInfo
        Parameters:
        id - the required ID value
        getParent - true if the parent of the element of type ID is requird
        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).
      • getUnparsedEntityNames

        public java.util.Iterator<java.lang.String> getUnparsedEntityNames()
        Get the list of unparsed entities defined in this document
        Specified by:
        getUnparsedEntityNames in interface TreeInfo
        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 TreeInfo
        Parameters:
        name - the name of the entity
        Returns:
        null: XOM does not provide access to unparsed entities
      • setSpaceStrippingRule

        public void setSpaceStrippingRule​(SpaceStrippingRule rule)
        Set details of space stripping action that was applied to this document during construction. This ensures that space stripping is not applied twice to the same document.
        Specified by:
        setSpaceStrippingRule in interface TreeInfo
        Parameters:
        rule - details of the space stripping rules that have been applied to this document during its construction.
        Since:
        9.9
      • getSpaceStrippingRule

        public SpaceStrippingRule getSpaceStrippingRule()
        Get details of space stripping action that was applied to this document during construction. This ensures that space stripping is not applied twice to the same document.
        Specified by:
        getSpaceStrippingRule in interface TreeInfo
        Returns:
        details of the space stripping rules that have been applied to this document during its construction. By default, returns NoElementsSpaceStrippingRule, indicating that no space stripping has been applied
        Since:
        9.9
      • setUserData

        public void setUserData​(java.lang.String key,
                                java.lang.Object value)
        Set user data on the document node. The user data can be retrieved subsequently using getUserData(java.lang.String)
        Specified by:
        setUserData in interface TreeInfo
        Parameters:
        key - A string giving the name of the property to be set. Clients are responsible for choosing a key that is likely to be unique. Must not be null. Keys used internally by Saxon are prefixed "saxon:".
        value - The value to be set for the property. May be null, which effectively removes the existing value for the property.
      • getUserData

        public java.lang.Object getUserData​(java.lang.String key)
        Get user data held in the document node. This retrieves properties previously set using setUserData(java.lang.String, java.lang.Object)
        Specified by:
        getUserData in interface TreeInfo
        Parameters:
        key - A string giving the name of the property to be retrieved.
        Returns:
        the value of the property, or null if the property has not been defined.