Package net.sf.saxon.option.xom

Class XOMDocumentWrapper

  • All Implemented Interfaces:
    Source, SourceLocator, net.sf.saxon.expr.parser.Location, net.sf.saxon.om.Item, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.om.TreeInfo, net.sf.saxon.tree.util.SteppingNode<XOMNodeWrapper>, net.sf.saxon.tree.wrapper.SiblingCountingNode, net.sf.saxon.tree.wrapper.VirtualNode, Locator
    public class XOMDocumentWrapper
extends XOMNodeWrapper
implements net.sf.saxon.om.TreeInfo
    The root node of an XPath tree. (Or equivalently, the tree itself).

    This class is used not only for a document, but also for the root of a document-less tree fragment.

    Author:
    Michael H. Kay, Wolfgang Hoschek (ported net.sf.saxon.jdom to XOM)

    • Field Detail

      • config

        protected net.sf.saxon.Configuration config

      • documentNumber

        protected long documentNumber

    • Constructor Detail

      • XOMDocumentWrapper

        public XOMDocumentWrapper​(nu.xom.Node root,
                          net.sf.saxon.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 net.sf.saxon.om.NodeInfo getRootNode()
        Get the NodeInfo object representing the document node at the root of the tree
        Specified by:
        getRootNode in interface net.sf.saxon.om.TreeInfo
        Returns:
        the document node

      • wrap

        public net.sf.saxon.om.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​(net.sf.saxon.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

      • getConfiguration

        public net.sf.saxon.Configuration getConfiguration()
        Get the configuration previously set using setConfiguration
        Specified by:
        getConfiguration in interface net.sf.saxon.om.NodeInfo
        Specified by:
        getConfiguration in interface net.sf.saxon.om.TreeInfo
        Overrides:
        getConfiguration in class XOMNodeWrapper

      • getNamePool

        public net.sf.saxon.om.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​(String uri)
        Specified by:
        setSystemId in interface Source
        Overrides:
        setSystemId in class net.sf.saxon.tree.wrapper.AbstractNodeWrapper

      • isTyped

        public boolean isTyped()
        Ask whether the document contains any nodes whose type annotation is anything other than UNTYPED
        Specified by:
        isTyped in interface net.sf.saxon.om.TreeInfo
        Returns:
        true if the document contains elements whose type is other than UNTYPED

      • 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 net.sf.saxon.om.TreeInfo
        Returns:
        the unique number identifying this document within the name pool

      • selectID

        public net.sf.saxon.om.NodeInfo selectID​(String id,
                                         boolean getParent)
        Get the element with a given ID, if any
        Specified by:
        selectID in interface net.sf.saxon.om.TreeInfo
        Parameters:
        id - the required ID value
        getParent -
        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 Iterator<String> getUnparsedEntityNames()
        Get the list of unparsed entities defined in this document
        Specified by:
        getUnparsedEntityNames in interface net.sf.saxon.om.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 String[] getUnparsedEntity​(String name)
        Get the unparsed entity with a given name
        Specified by:
        getUnparsedEntity in interface net.sf.saxon.om.TreeInfo
        Parameters:
        name - the name of the entity
        Returns:
        null: XOM does not provide access to unparsed entities

      • getSchemaType

        public net.sf.saxon.type.SchemaType getSchemaType()
        Get the type annotation of this node, if any. The type annotation is represented as SchemaType object.

        Types derived from a DTD are not reflected in the result of this method.

        Specified by:
        getSchemaType in interface net.sf.saxon.om.NodeInfo
        Overrides:
        getSchemaType in class XOMNodeWrapper
        Returns:
        For element and attribute nodes: the type annotation derived from schema validation (defaulting to xs:untyped and xs:untypedAtomic in the absence of schema validation). For comments, text nodes, processing instructions, and namespaces: null. For document nodes, either xs:untyped if the document has not been validated, or xs:anyType if it has.
        Since:
        9.4

      • setUserData

        public void setUserData​(String key,
                        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 net.sf.saxon.om.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 Object getUserData​(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 net.sf.saxon.om.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.