|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.tree.linked.NodeImpl
public abstract class NodeImpl
A node in the "linked" tree representing any kind of node except a namespace node. Specific node kinds are represented by concrete subclasses.
Field Summary | |
---|---|
static char[] |
NODE_LETTER
Chararacteristic letters to identify each type of node, indexed using the node type values. |
Fields inherited from interface net.sf.saxon.om.NodeInfo |
---|
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES |
Constructor Summary | |
---|---|
NodeImpl()
|
Method Summary | |
---|---|
void |
addAttribute(NodeName name,
SimpleType attType,
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. |
Value |
atomize()
Get the typed value. |
int |
compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order. |
void |
delete()
Delete this node (that is, detach it from its parent) |
boolean |
equals(Object other)
The equals() method compares nodes for identity. |
void |
generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node |
String |
getAttributeValue(int fingerprint)
Get the value of a given attribute of this node |
String |
getAttributeValue(String uri,
String localName)
Find the value of a given attribute of this node. |
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. |
String |
getDisplayName()
Get the display name of this node. |
long |
getDocumentNumber()
Get the document number of the document containing this node. |
DocumentInfo |
getDocumentRoot()
Get the root (document) node |
int |
getFingerprint()
Get the fingerprint of the node. |
NodeInfo |
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 |
String |
getLocalPart()
Get the local name of this node. |
int |
getNameCode()
Get the nameCode of the node. |
NamePool |
getNamePool()
Get the NamePool |
NodeImpl |
getNextInDocument(NodeImpl anchor)
Get the next node in document order |
NodeInfo |
getNextSibling()
Get next sibling node |
NodeInfo |
getParent()
Find the parent node of this node. |
DocumentImpl |
getPhysicalRoot()
Get the physical root of the tree. |
String |
getPrefix()
Get the prefix part of the name of this node. |
NodeImpl |
getPreviousInDocument()
Get the previous node in document order |
NodeInfo |
getPreviousSibling()
Get the previous sibling of the node |
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) |
CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence. |
String |
getSystemId()
Get the system ID for the node. |
int |
getTypeAnnotation()
Get the type annotation of this node, if any |
SequenceIterator<? extends AtomicValue> |
getTypedValue()
Get the typed value of this node. |
String |
getURI()
Get the URI part of the name of this node. |
boolean |
hasChildNodes()
Determine whether the node has any children. |
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 |
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. |
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(String uri)
Set the system ID of this node. |
void |
setTypeAnnotation(int typeCode)
Set the type annotation on a node. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.saxon.om.MutableNodeInfo |
---|
replaceStringValue |
Methods inherited from interface net.sf.saxon.om.NodeInfo |
---|
copy, getNodeKind, getStringValue, hashCode |
Field Detail |
---|
public static final char[] NODE_LETTER
Constructor Detail |
---|
public NodeImpl()
Method Detail |
---|
public CharSequence getStringValueCS()
getStringValueCS
in interface Item<NodeInfo>
getStringValueCS
in interface ValueRepresentation<NodeInfo>
Item.getStringValue()
public int getTypeAnnotation()
getTypeAnnotation
in interface NodeInfo
public SchemaType getSchemaType()
getSchemaType
in interface NodeInfo
public int getColumnNumber()
getColumnNumber
in interface SourceLocator
getColumnNumber
in interface NodeInfo
public String getPublicId()
getPublicId
in interface SourceLocator
public long getDocumentNumber()
getDocumentNumber
in interface NodeInfo
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 SequenceIterator<? extends AtomicValue> getTypedValue() throws XPathException
getTypedValue
in interface Item<NodeInfo>
XPathException
- where no typed value is available, for example in the case of
an element with complex contentpublic Value atomize() throws XPathException
Item.getTypedValue()
. However, this method is often more convenient and may be
more efficient, especially in the common case where the value is expected to be a singleton.
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(String uri)
setSystemId
in interface Source
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
in interface NodeInfo
other
- the node to be compared with this node
public boolean equals(Object other)
equals
in interface NodeInfo
equals
in class Object
other
- the node to be compared with this node
public int getNameCode()
getNameCode
in interface NodeInfo
allocate
,
getFingerprint
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 String getSystemId()
getSystemId
in interface Source
getSystemId
in interface SourceLocator
getSystemId
in interface NodeInfo
public 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 node
public Configuration getConfiguration()
getConfiguration
in interface NodeInfo
public NamePool getNamePool()
getNamePool
in interface NodeInfo
public String getPrefix()
getPrefix
in interface NodeInfo
public String getURI()
getURI
in interface NodeInfo
public String getDisplayName()
getDisplayName
in interface NodeInfo
public String getLocalPart()
getLocalPart
in interface NodeInfo
public int getLineNumber()
getLineNumber
in interface SourceLocator
getLineNumber
in interface NodeInfo
public final NodeInfo getParent()
getParent
in interface NodeInfo
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 NodeInfo getPreviousSibling()
public NodeInfo getNextSibling()
public NodeInfo getFirstChild()
public NodeInfo getLastChild()
public AxisIterator iterateAxis(byte axisNumber)
iterateAxis
in interface NodeInfo
axisNumber
- The axis to be iterated over
Axis
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 nodes
Axis
public String getAttributeValue(String uri, String localName)
getAttributeValue
in interface NodeInfo
uri
- the namespace uri of an attributelocalName
- the local name of an attribute
public String getAttributeValue(int fingerprint)
getAttributeValue
in interface NodeInfo
fingerprint
- The fingerprint of the attribute name
public NodeInfo getRoot()
getRoot
in interface NodeInfo
public DocumentInfo getDocumentRoot()
getDocumentRoot
in interface NodeInfo
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 node
public 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()
isId
in interface NodeInfo
public boolean isIdref()
isIdref
in interface NodeInfo
public boolean isNilled()
isNilled
in interface NodeInfo
public void setTypeAnnotation(int typeCode)
setTypeAnnotation
in interface MutableNodeInfo
typeCode
- 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, 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 properties
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 undeclared
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.
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 undeclared
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |