public abstract class NodeImpl extends java.lang.Object implements MutableNodeInfo, SteppingNode<NodeImpl>, SiblingCountingNode, javax.xml.transform.SourceLocator
Modifier and Type | Field and Description |
---|---|
static char[] |
NODE_LETTER
Chararacteristic letters to identify each type of node, indexed using the node type
values.
|
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
Constructor and Description |
---|
NodeImpl() |
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(NodeName name,
SimpleType attType,
java.lang.CharSequence value,
int properties)
Add an attribute to this element node.
|
void |
addNamespace(NamespaceBinding nscode,
boolean inherit)
Add a namespace binding (that is, a namespace node) to this element.
|
AtomicSequence |
atomize()
Get the typed value.
|
int |
compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
int |
comparePosition(NodeInfo other)
Determine the relative position of this node and another node, in document order,
distinguishing whether the first node is a preceding, following, descendant, ancestor,
or the same node as the second.
|
void |
delete()
Delete this node (that is, detach it from its parent)
|
boolean |
equals(java.lang.Object other)
The equals() method compares nodes for identity.
|
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node
|
java.lang.String |
getAttributeValue(java.lang.String uri,
java.lang.String localName)
Find the value of a given attribute of this node.
|
java.lang.String |
getBaseURI()
Get the base URI for the node.
|
int |
getColumnNumber()
Get the column number of the node.
|
Configuration |
getConfiguration()
Get the configuration
|
NamespaceBinding[] |
getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
java.lang.String |
getDisplayName()
Get the display name of this node.
|
int |
getFingerprint()
Get the fingerprint of the node.
|
NodeImpl |
getFirstChild()
Get first child - default implementation used for leaf nodes
|
NodeInfo |
getLastChild()
Get last child - default implementation used for leaf nodes
|
int |
getLineNumber()
Get the line number of the node within its source document entity
|
java.lang.String |
getLocalPart()
Get the local name of this node.
|
NamePool |
getNamePool()
Get the NamePool
|
NodeImpl |
getNextInDocument(NodeImpl anchor)
Get the next node in document order
|
NodeImpl |
getNextSibling()
Get next sibling node
|
NodeName |
getNodeName()
Get the name of the node.
|
NodeImpl |
getParent()
Find the parent node of this node.
|
DocumentImpl |
getPhysicalRoot()
Get the physical root of the tree.
|
java.lang.String |
getPrefix()
Get the prefix part of the name of this node.
|
NodeImpl |
getPreviousInDocument()
Get the previous node in document order
|
NodeImpl |
getPreviousSibling()
Get the previous sibling of the node
|
java.lang.String |
getPublicId()
Get the public identifier of the document entity containing this node.
|
protected net.sf.saxon.tree.linked.ParentNodeImpl |
getRawParent()
Get the raw value of the parent pointer.
|
NodeInfo |
getRoot()
Get the root node
|
SchemaType |
getSchemaType()
Get the type annotation
|
protected long |
getSequenceNumber()
Get the node sequence number (in document order).
|
int |
getSiblingPosition()
Get the index position of this node among its siblings (starting from 0)
|
java.lang.CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence.
|
NodeImpl |
getSuccessorElement(NodeImpl anchor,
java.lang.String uri,
java.lang.String local)
Find the next matching element in document order; that is, the first child element
with the required name if there is one; otherwise the next sibling element
if there is one; otherwise the next sibling element of the parent, grandparent, etc, up to the anchor element.
|
java.lang.String |
getSystemId()
Get the system ID for the node.
|
TreeInfo |
getTreeInfo()
Get information about the tree to which this NodeInfo belongs
|
java.lang.String |
getURI()
Get the URI part of the name of this node.
|
boolean |
hasChildNodes()
Determine whether the node has any children.
|
boolean |
hasFingerprint()
Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the
node in the NamePool.
|
NodeImpl |
head()
To implement
Sequence , this method returns the item itself |
void |
insertChildren(NodeInfo[] source,
boolean atStart,
boolean inherit)
Insert a sequence of nodes as children of this node.
|
void |
insertSiblings(NodeInfo[] source,
boolean before,
boolean inherit)
Insert copies of a sequence of nodes as siblings of this node.
|
boolean |
isDeleted()
Test whether this MutableNodeInfo object represents a node that has been deleted.
|
boolean |
isId()
Determine whether this node has the is-id property
|
boolean |
isIdref()
Determine whether this node has the is-idref property
|
boolean |
isNilled()
Determine whether the node has the is-nilled property
|
boolean |
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
|
boolean |
isStreamed()
Ask whether this is a node in a streamed document
|
SequenceIterator |
iterate()
To implement
Sequence , this method returns a singleton iterator
that delivers this item in the form of a sequence |
AxisIterator |
iterateAxis(byte axisNumber)
Return an enumeration over the nodes reached by the given axis from this node
|
AxisIterator |
iterateAxis(byte axisNumber,
NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node
|
Builder |
newBuilder()
Get a Builder suitable for building nodes that can be attached to this document.
|
void |
removeAttribute(NodeInfo attribute)
Remove an attribute from this element node
|
void |
removeTypeAnnotation()
Remove type information from this node (and its ancestors, recursively).
|
void |
rename(NodeName newNameCode)
Rename this node
|
void |
replace(NodeInfo[] replacement,
boolean inherit)
Replace this node with a given sequence of nodes.
|
Location |
saveLocation()
Get an immutable copy of this Location object.
|
protected void |
setRawParent(net.sf.saxon.tree.linked.ParentNodeImpl parent)
Set the raw parent pointer
|
protected void |
setSiblingPosition(int index)
Set the index position.
|
void |
setSystemId(java.lang.String uri)
Set the system ID of this node.
|
void |
setTypeAnnotation(SchemaType type)
Set the type annotation on a node.
|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
replaceStringValue
copy, getNodeKind, getStringValue, hashCode
public static final char[] NODE_LETTER
public SequenceIterator iterate()
Sequence
, this method returns a singleton iterator
that delivers this item in the form of a sequencepublic TreeInfo getTreeInfo()
getTreeInfo
in interface NodeInfo
public java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
Item.getStringValue()
public SchemaType getSchemaType()
getSchemaType
in interface NodeInfo
public int getColumnNumber()
getColumnNumber
in interface javax.xml.transform.SourceLocator
getColumnNumber
in interface Location
getColumnNumber
in interface NodeInfo
getColumnNumber
in interface org.xml.sax.Locator
public java.lang.String getPublicId()
getPublicId
in interface javax.xml.transform.SourceLocator
getPublicId
in interface Location
getPublicId
in interface NodeInfo
getPublicId
in interface org.xml.sax.Locator
public final int getSiblingPosition()
getSiblingPosition
in interface SiblingCountingNode
protected final void setSiblingPosition(int index)
index
- the position of the node among its siblings, counting from zero.public AtomicSequence atomize() throws XPathException
atomize
in interface Item
atomize
in interface NodeInfo
XPathException
- if the node has no typed value, for example if
it is an element node with element-only contentpublic void setSystemId(java.lang.String uri)
setSystemId
in interface javax.xml.transform.Source
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
in interface NodeInfo
other
- the node to be compared with this nodepublic boolean equals(java.lang.Object other)
equals
in interface NodeInfo
equals
in class java.lang.Object
other
- the node to be compared with this nodepublic NodeName getNodeName()
public boolean hasFingerprint()
getFingerprint()
method must
return the fingerprint of the node. If the answer is false, then the getFingerprint()
method should throw an UnsupportedOperationException
. In the case of unnamed nodes
such as text nodes, the result can be either true (in which case getFingerprint() should
return -1) or false (in which case getFingerprint may throw an exception).hasFingerprint
in interface NodeInfo
FingerprintedNode
as a marker interface.public int getFingerprint()
getFingerprint
in interface NodeInfo
public void generateId(FastStringBuffer buffer)
generateId
in interface NodeInfo
buffer
- a buffer which will be updated to hold a string
that uniquely identifies this node, across all documents.public java.lang.String getSystemId()
getSystemId
in interface javax.xml.transform.Source
getSystemId
in interface javax.xml.transform.SourceLocator
getSystemId
in interface Location
getSystemId
in interface NodeInfo
getSystemId
in interface org.xml.sax.Locator
public java.lang.String getBaseURI()
getBaseURI
in interface NodeInfo
protected long getSequenceNumber()
public final int compareOrder(NodeInfo other)
compareOrder
in interface NodeInfo
other
- The other node, whose position is to be compared with this nodepublic int comparePosition(NodeInfo other)
comparePosition
in interface NodeInfo
other
- The other node, whose position is to be compared with this
nodeAxisInfo.PRECEDING
if this node is on the preceding axis of the other node;
AxisInfo.FOLLOWING
if it is on the following axis; AxisInfo.ANCESTOR
if the first node is an
ancestor of the second; AxisInfo.DESCENDANT
if the first is a descendant of the second;
AxisInfo.SELF
if they are the same node.java.lang.UnsupportedOperationException
- if either node is an attribute or namespacepublic Configuration getConfiguration()
getConfiguration
in interface NodeInfo
public NamePool getNamePool()
public java.lang.String getPrefix()
public java.lang.String getURI()
public java.lang.String getDisplayName()
getDisplayName
in interface NodeInfo
public java.lang.String getLocalPart()
getLocalPart
in interface NodeInfo
public int getLineNumber()
getLineNumber
in interface javax.xml.transform.SourceLocator
getLineNumber
in interface Location
getLineNumber
in interface NodeInfo
getLineNumber
in interface org.xml.sax.Locator
public Location saveLocation()
saveLocation
in interface Location
public final NodeImpl getParent()
getParent
in interface NodeInfo
getParent
in interface SteppingNode<NodeImpl>
protected final net.sf.saxon.tree.linked.ParentNodeImpl getRawParent()
protected final void setRawParent(net.sf.saxon.tree.linked.ParentNodeImpl parent)
parent
- the "raw" parent pointer: either the real parent, or a dummy parent
added to ensure that the tree is properly rooted.public NodeImpl getPreviousSibling()
getPreviousSibling
in interface SteppingNode<NodeImpl>
public NodeImpl getNextSibling()
getNextSibling
in interface SteppingNode<NodeImpl>
public NodeImpl getFirstChild()
getFirstChild
in interface SteppingNode<NodeImpl>
public NodeInfo getLastChild()
public AxisIterator iterateAxis(byte axisNumber)
iterateAxis
in interface NodeInfo
axisNumber
- The axis to be iterated overAxisInfo
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
iterateAxis
in interface NodeInfo
axisNumber
- The axis to be iterated overnodeTest
- A pattern to be matched by the returned nodesAxisInfo
public java.lang.String getAttributeValue(java.lang.String uri, java.lang.String localName)
getAttributeValue
in interface NodeInfo
uri
- the namespace uri of an attributelocalName
- the local name of an attributepublic NodeInfo getRoot()
public DocumentImpl getPhysicalRoot()
public NodeImpl getNextInDocument(NodeImpl anchor)
anchor
- the scan stops when it reaches a node that is not a descendant of the specified
anchor nodepublic NodeImpl getSuccessorElement(NodeImpl anchor, java.lang.String uri, java.lang.String local)
SteppingNode
getSuccessorElement
in interface SteppingNode<NodeImpl>
anchor
- the root of the tree within which navigation is confineduri
- the required namespace URI, or null if any namespace is acceptablelocal
- the required local name, or null if any local name is acceptablepublic NodeImpl getPreviousInDocument()
public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
getDeclaredNamespaces
in interface NodeInfo
buffer
- If this is non-null, and the result array fits in this buffer, then the result
may overwrite the contents of this array, to avoid the cost of allocating a new array on the heap.For a node other than an element, the method returns null.
public boolean hasChildNodes()
hasChildNodes
in interface NodeInfo
true
if the node has any children,
false
if the node has no children.public boolean isId()
public boolean isIdref()
public boolean isNilled()
public boolean isStreamed()
isStreamed
in interface NodeInfo
public void setTypeAnnotation(SchemaType type)
setTypeAnnotation
in interface MutableNodeInfo
type
- the type annotation (possibly including high bits set to indicate the isID, isIDREF, and
isNilled properties)public void delete()
delete
in interface MutableNodeInfo
public boolean isDeleted()
isDeleted
in interface MutableNodeInfo
public void removeAttribute(NodeInfo attribute)
If this node is not an element, or if the specified node is not an attribute of this element, this method takes no action.
The attribute object itself becomes unusable; any attempt to use this attribute object, or any other object representing the same node, is likely to result in an exception.
removeAttribute
in interface MutableNodeInfo
attribute
- the attribute node to be removedpublic void addAttribute(NodeName name, SimpleType attType, java.lang.CharSequence value, int properties)
If this node is not an element, or if the supplied node is not an attribute, the method takes no action. If the element already has an attribute with this name, the method throws an exception.
This method does not perform any namespace fixup. It is the caller's responsibility to ensure that any namespace prefix used in the name of the attribute (or in its value if it has a namespace-sensitive type) is declared on this element.
addAttribute
in interface MutableNodeInfo
name
- the name of the new attributeattType
- the type annotation of the new attributevalue
- the string value of the new attributeproperties
- properties including IS_ID and IS_IDREF propertiesjava.lang.IllegalStateException
- if the element already has an attribute with the given name.public void rename(NodeName newNameCode)
rename
in interface MutableNodeInfo
newNameCode
- the NamePool code of the new namepublic void addNamespace(NamespaceBinding nscode, boolean inherit)
MutableNodeInfo
addNamespace
in interface MutableNodeInfo
nscode
- The namespace code representing the (prefix, uri) pair of the namespace binding to be
added. If the target element already has a namespace binding with this (prefix, uri) pair, the call has
no effect. If the target element currently has a namespace binding with this prefix and a different URI, an
exception is raised.inherit
- If true, the new namespace binding will be inherited by any children of the target element
that do not already have a namespace binding for the specified prefix, recursively.
If false, the new namespace binding will not be inherited.public void replace(NodeInfo[] replacement, boolean inherit)
The supplied nodes will become children of this node's parent. Adjacent text nodes will be merged, and zero-length text nodes removed. The supplied nodes may be modified in situ, for example to change their parent property and to add namespace bindings, or they may be copied, at the discretion of the implementation.
replace
in interface MutableNodeInfo
replacement
- the replacement nodes. If this node is an attribute, the replacements
must also be attributes; if this node is not an attribute, the replacements must not be attributes.
source the nodes to be inserted. The implementation determines what implementation classes
of node it will accept; this implementation will accept attribute, text, comment, and processing instruction
nodes belonging to any implementation, but elements must be instances of ElementImpl
.
The supplied nodes will be modified in situ, for example
to change their parent property and to add namespace bindings, if they are instances of
ElementImpl
; otherwise they will be copied. If the nodes are copied, then on return
the supplied source array will contain the copy rather than the original.inherit
- true if the replacement nodes are to inherit the namespaces of their new parent; false
if such namespaces are to be undeclaredjava.lang.IllegalArgumentException
- if any of the replacement nodes is of the wrong kind. When replacing
a child node, the replacement nodes must all be elements, text, comment, or PI nodes; when replacing
an attribute, the replacement nodes must all be attributes.java.lang.IllegalStateException
- if this node is deleted or if it has no parent node.
or if two replacement attributes have the same name.public void insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
This method takes no action unless the target node is a document node or element node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes will form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed. The supplied nodes may be modified in situ, for example to change their parent property and to add namespace bindings, or they may be copied, at the discretion of the implementation.
insertChildren
in interface MutableNodeInfo
source
- the nodes to be inserted. The implementation determines what implementation classes
of node it will accept; all implementations must accept nodes constructed using the Builder supplied
by the newBuilder()
method on this object. The supplied nodes may be modified in situ, for example
to change their parent property and to add namespace bindings, but this depends on the implementation.
The argument array may be modified as a result of the call.atStart
- true if the new nodes are to be inserted before existing children; false if they are
to be inserted after existing childreninherit
- true if the inserted nodes are to inherit the namespaces of their new parent; false
if such namespaces are to be undeclaredjava.lang.IllegalArgumentException
- if the supplied nodes use a node implementation that this
implementation does not accept.public void insertSiblings(NodeInfo[] source, boolean before, boolean inherit)
This method takes no action unless the target node is an element, text node, comment, or processing instruction, and one that has a parent node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes must use the same data model implementation as the tree into which they will be inserted.
insertSiblings
in interface MutableNodeInfo
source
- the nodes to be insertedbefore
- true if the new nodes are to be inserted before the target node; false if they areinherit
- true if the inserted nodes are to inherit the namespaces of their new parent; false
if such namespaces are to be undeclaredpublic void removeTypeAnnotation()
removeTypeAnnotation
in interface MutableNodeInfo
public Builder newBuilder()
newBuilder
in interface MutableNodeInfo
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.