Class TinyNodeImpl

  • All Implemented Interfaces:
    NodeInfo, javax.xml.transform.dom.DOMLocator, javax.xml.transform.Source, javax.xml.transform.SourceLocator, org.w3c.dom.Node
    Direct Known Subclasses:
    TinyAttributeImpl, TinyCommentImpl, TinyNamespaceImpl, TinyParentNodeImpl, TinyProcInstImpl, TinyTextImpl

    abstract class TinyNodeImpl
    extends AbstractNode
    A node in the XML parse tree representing an XML element, character content, or attribute.

    This is the top-level class in the implementation class hierarchy; it essentially contains all those methods that can be defined using other primitive methods, without direct access to data.

    Author:
    Michael H. Kay
    • Constructor Detail

      • TinyNodeImpl

        TinyNodeImpl()
    • Method Detail

      • setSystemId

        public void setSystemId​(java.lang.String uri)
        Set the system id of this node.
        This method is present to ensure that the class implements the javax.xml.transform.Source interface, so a node can be used as the source of a transformation.
      • setParentNode

        protected void setParentNode​(TinyNodeImpl parent)
        Set the parent of this node. Providing this information is useful, if it is known, because otherwise getParent() has to search backwards through the document.
      • isSameNodeInfo

        public boolean isSameNodeInfo​(NodeInfo other)
        Determine whether this is the same node as another node
        Specified by:
        isSameNodeInfo in interface NodeInfo
        Specified by:
        isSameNodeInfo in class AbstractNode
        Returns:
        true if this Node object and the supplied Node object represent the same node in the tree.
      • getSystemId

        public java.lang.String getSystemId()
        Get the system ID for the entity containing the 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
        Specified by:
        getSystemId in class AbstractNode
        Returns:
        the System Identifier of the entity in the source document containing the node, or null if not known. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot.
      • getBaseURI

        public java.lang.String getBaseURI()
        Get the base URI for the node. Default implementation for child nodes gets the base URI of the parent node.
        Specified by:
        getBaseURI in interface org.w3c.dom.Node
        Specified by:
        getBaseURI in interface NodeInfo
        Specified by:
        getBaseURI in class AbstractNode
      • getOriginatingNode

        public org.w3c.dom.Node getOriginatingNode()
        Get the node corresponding to this javax.xml.transform.dom.DOMLocator
        Specified by:
        getOriginatingNode in interface javax.xml.transform.dom.DOMLocator
        Overrides:
        getOriginatingNode in class AbstractNode
      • setLineNumber

        public void setLineNumber​(int line)
        Set the line number of the node within its source document entity
      • getLineNumber

        public int getLineNumber()
        Get the line number of the node within its source document entity
        Specified by:
        getLineNumber in interface NodeInfo
        Specified by:
        getLineNumber in interface javax.xml.transform.SourceLocator
        Overrides:
        getLineNumber in class AbstractNode
        Returns:
        the line number of the node in its original source document; or -1 if not available
      • getSequenceNumber

        protected long getSequenceNumber()
        Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. The sequence number must be unique within the document (not, as in previous releases, within the whole document collection)
      • compareOrder

        public final int compareOrder​(NodeInfo other)
        Determine the relative position of this node and another node, in document order. The other node will always be in the same document.
        Specified by:
        compareOrder in interface NodeInfo
        Specified by:
        compareOrder in class AbstractNode
        Parameters:
        other - The other node, whose position is to be compared with this node
        Returns:
        -1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())
      • getPrefix

        public java.lang.String getPrefix()
        Get the prefix part of the name of this node. This is the name before the ":" if any.
        Specified by:
        getPrefix in interface org.w3c.dom.Node
        Specified by:
        getPrefix in interface NodeInfo
        Specified by:
        getPrefix in class AbstractNode
        Returns:
        the prefix part of the name. For an unnamed node, return "".
      • getURI

        public java.lang.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
        Specified by:
        getURI in class AbstractNode
        Returns:
        The URI of the namespace of this node. For an unnamed node, or for an element or attribute in the default namespace, return an empty string.
      • getDisplayName

        public java.lang.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 AbstractNode
        Returns:
        The display name of this node. For a node with no name, return an empty string.
      • getLocalName

        public java.lang.String getLocalName()
        Get the local name of this node.
        Specified by:
        getLocalName in interface org.w3c.dom.Node
        Specified by:
        getLocalName in interface NodeInfo
        Specified by:
        getLocalName in class AbstractNode
        Returns:
        The local name of this node. For a node with no name, return an empty string.
      • getEnumeration

        public AxisEnumeration getEnumeration​(byte axisNumber,
                                              NodeTest nodeTest)
        Return an enumeration over the nodes reached by the given axis from this node
        Specified by:
        getEnumeration in interface NodeInfo
        Specified by:
        getEnumeration in class AbstractNode
        Parameters:
        axisNumber - Identifies the required axis, eg. Axis.CHILD or Axis.PARENT
        nodeTest - A pattern to be matched by the returned nodes
        Returns:
        a AxisEnumeration that scans the nodes reached by the axis in turn.
      • getParent

        public NodeInfo getParent()
        Find the parent node of this node.
        Specified by:
        getParent in interface NodeInfo
        Specified by:
        getParent in class AbstractNode
        Returns:
        The Node object describing the containing element or root node.
      • hasChildNodes

        public boolean hasChildNodes()
        Determine whether the node has any children.
        Specified by:
        hasChildNodes in interface org.w3c.dom.Node
        Specified by:
        hasChildNodes in interface NodeInfo
        Specified by:
        hasChildNodes in class AbstractNode
        Returns:
        true if this node has any attributes, false otherwise.
      • hasAttributes

        public boolean hasAttributes()
        Returns whether this node has any attributes.
        Specified by:
        hasAttributes in interface org.w3c.dom.Node
        Specified by:
        hasAttributes in class AbstractNode
        Returns:
        true if this node has any attributes, false otherwise.
        Since:
        DOM Level 2
      • getAttributeValue

        public java.lang.String getAttributeValue​(java.lang.String uri,
                                                  java.lang.String localName)
        Find the value of a given attribute of this node.
        This method is defined on all nodes to meet XSL requirements, but for nodes other than elements it will always return null.
        Specified by:
        getAttributeValue in interface NodeInfo
        Specified by:
        getAttributeValue in class AbstractNode
        Parameters:
        uri - the namespace uri of an attribute
        localName - the local name of an attribute
        Returns:
        the value of the attribute, if it exists, otherwise null
      • getAttributeValue

        public java.lang.String getAttributeValue​(int fingerprint)
        Get the value of a given attribute of this node
        Specified by:
        getAttributeValue in interface NodeInfo
        Specified by:
        getAttributeValue in class AbstractNode
        Parameters:
        fingerprint - The fingerprint of the attribute name
        Returns:
        the attribute value if it exists or null if not
      • outputNamespaceNodes

        public void outputNamespaceNodes​(Outputter out,
                                         boolean includeAncestors)
                                  throws javax.xml.transform.TransformerException
        Output all namespace nodes associated with this element. Does nothing if the node is not an element.
        Specified by:
        outputNamespaceNodes in interface NodeInfo
        Overrides:
        outputNamespaceNodes in class AbstractNode
        Parameters:
        out - The relevant outputter
        includeAncestors - True if namespaces declared on ancestor elements must be output; false if it is known that these are already on the result tree
        Throws:
        javax.xml.transform.TransformerException
      • generateId

        public java.lang.String generateId()
        Get a character string that uniquely identifies this node
        Specified by:
        generateId in interface NodeInfo
        Specified by:
        generateId in class AbstractNode
        Returns:
        a string.