net.sf.saxon.tinytree
Class TinyNodeImpl

java.lang.Object
  net.sf.saxon.om.AbstractNode
      net.sf.saxon.tinytree.TinyNodeImpl

All Implemented Interfaces:

DOMLocator, Source, SourceLocator, Item, NodeInfo, 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:

Field Summary

protected TinyDocumentImpl	document
protected int	nodeNr
protected TinyNodeImpl	parent

Fields inherited from class net.sf.saxon.om.AbstractNode

NODE_LETTER

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

TinyNodeImpl()

Method Summary

int	compareOrder(NodeInfo other) Determine the relative position of this node and another node, in document order.
String	generateId() Get a character string that uniquely identifies this node
String	getAttributeValue(int fingerprint) Get the value of a given attribute of this node
String	getBaseURI() Get the base URI for the node.
String	getDisplayName() Get the display name of this node.
int	getDocumentNumber() Get the document number of the document containing this node (Needed when the document isn't a real node, for sorting free-standing elements)
DocumentInfo	getDocumentRoot() Get the root (document) node
int	getFingerprint() Get the fingerprint of the node, used for matching names
int	getLineNumber() Get the line number of the node within its source document entity
String	getLocalPart() Get the local name of this node.
int	getNameCode() Get the name code of the node, used for matching names
NamePool	getNamePool() Get the NamePool for the tree containing this node
Node	getOriginatingNode() Get the node corresponding to this javax.xml.transform.dom.DOMLocator
NodeInfo	getParent() Find the parent node of this node.
String	getPrefix() Get the prefix part of the name of this node.
NodeInfo	getRoot() Get the root node of the tree (not necessarily a document node)
protected long	getSequenceNumber() Get the node sequence number (in document order).
String	getSystemId() Get the system ID for the entity containing the node.
String	getURI() Get the URI part of the name of this node.
boolean	hasAttributes() Returns whether this node has any attributes.
boolean	hasChildNodes() Determine whether the node has any children.
boolean	isSameNode(NodeInfo other) Determine whether this is the same node as another node
AxisIterator	iterateAxis(byte axisNumber) Return an iterator over all the nodes reached by the given axis from this node
AxisIterator	iterateAxis(byte axisNumber, NodeTest nodeTest) Return an iterator over the nodes reached by the given axis from this node
void	outputNamespaceNodes(Receiver out, boolean includeAncestors) Output all namespace nodes associated with this element.
protected void	setParentNode(TinyNodeImpl parent) Set the parent of this node.
void	setSystemId(String uri) Set the system id of this node.

Methods inherited from class net.sf.saxon.om.AbstractNode

appendChild, appendData, cloneNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getChildNodes, getColumnNumber, getData, getDoctype, getDocumentElement, getElementById, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getImplementation, getLastChild, getLength, getLocalName, getName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerElement, getParentNode, getPreviousSibling, getPublicId, getSpecified, getStringValue, getTagName, getTypeAnnotation, getTypedValue, getValue, hasAttribute, hasAttributeNS, importNode, insertBefore, insertData, isSupported, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, replaceChild, replaceData, setAttributeNode, setAttributeNodeNS, setAttributeNS, setData, setNodeValue, setPrefix, setValue, splitText, substringData, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

compareDocumentPosition, getFeature, getTextContent, getUserData, isDefaultNamespace, isEqualNode, isSameNode, lookupNamespaceURI, lookupPrefix, setTextContent, setUserData

Methods inherited from interface net.sf.saxon.om.NodeInfo

copy, getNodeKind

Field Detail

document

protected TinyDocumentImpl document

nodeNr

protected int nodeNr

parent

protected TinyNodeImpl parent

Constructor Detail

TinyNodeImpl

TinyNodeImpl()

Method Detail

setSystemId

public void setSystemId(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.

isSameNode

public boolean isSameNode(NodeInfo other)

Determine whether this is the same node as another node

Specified by:

isSameNode in interface NodeInfo

Specified by:

isSameNode in class AbstractNode

Parameters:

other - the node to be compared with this node

Returns:

true if this Node object and the supplied Node object represent the same node in the tree.

getSystemId

public String getSystemId()

Get the system ID for the entity containing the node.

Specified by:

getSystemId in interface Source

Specified by:

getSystemId in interface SourceLocator

Specified by:

getSystemId in interface NodeInfo

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 gets the base URI of the parent node.

Specified by:

getBaseURI in interface NodeInfo

Specified by:

getBaseURI in interface Node

Specified by:

getBaseURI in class AbstractNode

Returns:

the base URI of the node

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

getLineNumber

public int getLineNumber()

Get the line number of the node within its source document entity

Specified by:

getLineNumber in interface SourceLocator

Specified by:

getLineNumber in interface NodeInfo

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())

getFingerprint

public int getFingerprint()

Get the fingerprint of the node, used for matching names

Specified by:

getFingerprint in interface NodeInfo

Specified by:

getFingerprint in class AbstractNode

Returns:

an integer fingerprint; two nodes with the same fingerprint have the same expanded QName

getNameCode

public int getNameCode()

Get the name code of the node, used for matching names

Specified by:

getNameCode in interface NodeInfo

Specified by:

getNameCode in class AbstractNode

Returns:

an integer name code, which may be used to obtain the actual node name from the name pool

See Also:

allocate, getFingerprint

getPrefix

public String getPrefix()

Get the prefix part of the name of this node. This is the name before the ":" if any.

Returns:

the prefix part of the name. For an unnamed node, return "".

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 an unnamed node, or for an element or attribute in the default namespace, return an empty string.

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.

getLocalPart

public String getLocalPart()

Get the local name of this node.

Specified by:

getLocalPart in interface NodeInfo

Specified by:

getLocalPart in class AbstractNode

Returns:

The local name of this node. For a node with no name, return "".

iterateAxis

public AxisIterator iterateAxis(byte axisNumber)

Return an iterator over all the nodes reached by the given axis from this node

Parameters:

axisNumber - Identifies the required axis, eg. Axis.CHILD or Axis.PARENT

Returns:

a AxisIteratorImpl that scans the nodes reached by the axis in turn.

See Also:

Axis

iterateAxis

public AxisIterator iterateAxis(byte axisNumber,
                                NodeTest nodeTest)

Return an iterator over the nodes reached by the given axis from this node

Specified by:

iterateAxis in interface NodeInfo

Specified by:

iterateAxis 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 AxisIteratorImpl that scans the nodes reached by the axis in turn.

See Also:

Axis

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 NodeInfo

Specified by:

hasChildNodes in interface Node

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 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(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

getRoot

public NodeInfo getRoot()

Get the root node of the tree (not necessarily a document node)

Specified by:

getRoot in interface NodeInfo

Overrides:

getRoot in class AbstractNode

Returns:

the NodeInfo representing the root of this tree

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

getNamePool

public NamePool getNamePool()

Get the NamePool for the tree containing this node

Returns:

the NamePool

outputNamespaceNodes

public void outputNamespaceNodes(Receiver 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

generateId

public 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.

getDocumentNumber

public int getDocumentNumber()

Get the document number of the document containing this node (Needed when the document isn't a real node, for sorting free-standing elements)

Specified by:

getDocumentNumber in interface NodeInfo

Overrides:

getDocumentNumber in class AbstractNode