Class NodeImpl

java.lang.Object
com.icl.saxon.om.AbstractNode
com.icl.saxon.tree.NodeImpl
All Implemented Interfaces:
NodeInfo, DOMLocator, Source, SourceLocator, Node
Direct Known Subclasses:
AttributeImpl, CommentImpl, NamespaceImpl, ParentNodeImpl, ProcInstImpl, TextImpl

public abstract class NodeImpl 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
  • Field Details

    • emptyArray

      protected static NodeInfo[] emptyArray
    • parent

      protected ParentNodeImpl parent
    • index

      protected int index
  • Constructor Details

    • NodeImpl

      public NodeImpl()
  • Method Details

    • setSystemId

      public void setSystemId(String uri)
      Set the system ID of this node. This method is provided so that a NodeInfo implements the javax.xml.transform.Source interface, allowing a node to be used directly as the Source of a transformation
    • 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.
    • getNameCode

      public int getNameCode()
      Get the nameCode of the node. This is used to locate the name in the NamePool
      Specified by:
      getNameCode in interface NodeInfo
      Specified by:
      getNameCode in class AbstractNode
      See Also:
    • getFingerprint

      public int getFingerprint()
      Get the fingerprint of the node. This is used to compare whether two nodes have equivalent names. Return -1 for a node with no name.
      Specified by:
      getFingerprint in interface NodeInfo
      Specified by:
      getFingerprint in class AbstractNode
    • generateId

      public String generateId()
      Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)
      Specified by:
      generateId in interface NodeInfo
      Specified by:
      generateId in class AbstractNode
      Returns:
      a string.
    • getOriginatingNode

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

      public String getSystemId()
      Get the system ID for the node. Default implementation for child nodes.
      Specified by:
      getSystemId in interface NodeInfo
      Specified by:
      getSystemId in interface Source
      Specified by:
      getSystemId in interface 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 String getBaseURI()
      Get the base URI for the node. Default implementation for child nodes.
      Specified by:
      getBaseURI in interface Node
      Specified by:
      getBaseURI in interface NodeInfo
      Specified by:
      getBaseURI in class AbstractNode
    • getSequenceNumber

      protected 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 roots) 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. This is the default implementation for child nodes.
    • 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())
    • getNamePool

      public NamePool getNamePool()
      Get the NamePool
    • getPrefix

      public 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 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 an empty string.
    • 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
      Specified by:
      getURI in class AbstractNode
      Returns:
      The URI of the namespace of this node. For the default namespace, return an empty string. For an unnamed node, return null.
    • 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 AbstractNode
      Returns:
      The display name of this node. For a node with no name, return an empty string.
    • getLocalName

      public String getLocalName()
      Get the local name of this node.
      Specified by:
      getLocalName in interface 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.
    • 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 SourceLocator
      Overrides:
      getLineNumber in class AbstractNode
      Returns:
      the line number of the node in its original source document; or -1 if not available
    • getParent

      public final 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.
    • getPreviousSibling

      public Node getPreviousSibling()
      Get the previous sibling of the node
      Specified by:
      getPreviousSibling in interface Node
      Overrides:
      getPreviousSibling in class AbstractNode
      Returns:
      The previous sibling node. Returns null if the current node is the first child of its parent.
    • getNextSibling

      public Node getNextSibling()
      Get next sibling node
      Specified by:
      getNextSibling in interface Node
      Overrides:
      getNextSibling in class AbstractNode
      Returns:
      The next sibling node of the required type. Returns null if the current node is the last child of its parent.
    • getFirstChild

      public Node getFirstChild()
      Get first child - default implementation used for leaf nodes
      Specified by:
      getFirstChild in interface Node
      Overrides:
      getFirstChild in class AbstractNode
      Returns:
      null
    • getLastChild

      public Node getLastChild()
      Get last child - default implementation used for leaf nodes
      Specified by:
      getLastChild in interface Node
      Overrides:
      getLastChild in class AbstractNode
      Returns:
      null
    • 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 - The axis to be used (a constant in class Axis)
      nodeTest - A pattern to be matched by the returned nodes
      node - NodeInfo representing the node from which the enumeration starts
      nodeType - the type(s) of node to be included, e.g. NodeInfo.ELEMENT, NodeInfo.TEXT. The value NodeInfo.NODE means include any type of node.
      Returns:
      an AxisEnumeration that scans the nodes reached by the axis in turn.
    • hasAttributes

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

      public String getAttributeValue(String uri, 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 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
    • getDocumentElement

      public Element getDocumentElement()
      Get the outermost element.
      Overrides:
      getDocumentElement in class AbstractNode
      Returns:
      the Element node for the outermost element of the document. If the document is not well-formed, this returns the last element child of the root if there is one, otherwise null.
    • getDocumentRoot

      public DocumentInfo getDocumentRoot()
      Get the root (document) node
      Specified by:
      getDocumentRoot in interface NodeInfo
      Overrides:
      getDocumentRoot in class AbstractNode
      Returns:
      the DocumentInfo representing the containing document
    • getNextInDocument

      public NodeImpl getNextInDocument(NodeImpl anchor)
      Get the next node in document order
      Parameters:
      anchor - : the scan stops when it reaches a node that is not a descendant of the specified anchor node
      Returns:
      the next node in the document, or null if there is no such node
    • getPreviousInDocument

      public NodeImpl getPreviousInDocument()
      Get the previous node in document order
      Returns:
      the previous node in the document, or null if there is no such node
    • outputNamespaceNodes

      public void outputNamespaceNodes(Outputter out, boolean includeAncestors) throws 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:
      TransformerException
    • removeNode

      public void removeNode()
      Remove this node from the tree. For system use only. When one or more nodes have been removed, renumberChildren() must be called to adjust the numbering of remaining nodes. PRECONDITION: The node must have a parent node.
    • getChildNodes

      public NodeList getChildNodes()
      Return a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
      Specified by:
      getChildNodes in interface Node
      Overrides:
      getChildNodes in class AbstractNode
    • getAttributes

      public NamedNodeMap getAttributes()
      Return a NamedNodeMap containing the attributes of this node (if it is an Element ) or null otherwise. (DOM method)
      Specified by:
      getAttributes in interface Node
      Overrides:
      getAttributes in class AbstractNode
    • hasChildNodes

      public boolean hasChildNodes()
      Determine whether the node has any children.
      Specified by:
      hasChildNodes in interface Node
      Specified by:
      hasChildNodes in interface NodeInfo
      Specified by:
      hasChildNodes in class AbstractNode
      Returns:
      true if the node has any children, false if the node has no children.