public abstract class AbstractNodeWrapper extends java.lang.Object implements NodeInfo, VirtualNode
This implementation of the NodeInfo interface contains common code used by many "wrapper" implementations for external data models.
Modifier and Type | Field and Description |
---|---|
protected TreeInfo |
treeInfo |
IS_DTD_TYPE, IS_NILLED
Constructor and Description |
---|
AbstractNodeWrapper() |
Modifier and Type | Method and Description |
---|---|
AtomicSequence |
atomize()
Get the typed value.
|
boolean |
equals(java.lang.Object other)
The equals() method compares nodes for identity.
|
NamespaceMap |
getAllNamespaces()
Get all the namespace bindings that are in-scope for this element.
|
java.lang.String |
getAttributeValue(java.lang.String uri,
java.lang.String local)
Get the string value of a given attribute of this node.
|
java.lang.String |
getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained
in the node.
|
int |
getColumnNumber()
Get column number
|
NamespaceBinding[] |
getDeclaredNamespaces(NamespaceBinding[] buffer)
Get all namespace declarations 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
|
int |
getLineNumber()
Get line number
|
NamePool |
getNamePool()
Get the name pool for this node
|
java.lang.Object |
getRealNode()
Get the node underlying this virtual node.
|
NodeInfo |
getRoot()
Get the root node - always a document node with this tree implementation
|
java.lang.String |
getStringValue()
Return the string value of the node.
|
java.lang.String |
getSystemId()
Get the System ID for the node.
|
TreeInfo |
getTreeInfo()
Get information about the tree to which this NodeInfo belongs
|
boolean |
hasChildNodes()
Determine whether the node has any children.
|
boolean |
hasFingerprint()
Test whether a fingerprint is available for the node name
|
int |
hashCode()
The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal
(represent the same node) then they must have the same hashCode()
|
protected abstract AxisIterator |
iterateAttributes(java.util.function.Predicate<? super NodeInfo> nodeTest)
Return an iterator over the attributes of this element node.
|
AxisIterator |
iterateAxis(int axisNumber)
Return an iteration over the nodes reached by the given axis from this node
|
AxisIterator |
iterateAxis(int axisNumber,
java.util.function.Predicate<? super NodeInfo> nodeTest)
Return an iteration over the nodes reached by the given axis from this node.
|
protected abstract AxisIterator |
iterateChildren(java.util.function.Predicate<? super NodeInfo> nodeTest)
Return an iterator over the children of this node.
|
protected AxisIterator |
iterateDescendants(java.util.function.Predicate<? super NodeInfo> nodeTest,
boolean includeSelf)
Return an iterator over the descendants of this node.
|
protected abstract AxisIterator |
iterateSiblings(java.util.function.Predicate<? super NodeInfo> nodeTest,
boolean forwards)
Return an iterator over the siblings of this node.
|
Location |
saveLocation()
Get an immutable copy of this Location object.
|
void |
setSystemId(java.lang.String uri)
Set the system ID.
|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getUnderlyingNode
attributes, children, children, compareOrder, copy, generateId, getConfiguration, getGenre, getLocalPart, getNodeKind, getParent, getPrefix, getPublicId, getSchemaType, getURI, isId, isIdref, isNilled, isSameNodeInfo, isStreamed, toShortString
getLength, getStringValueCS, head, itemAt, iterate, reduce, subsequence, toGroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
makeRepeatable
protected TreeInfo treeInfo
public TreeInfo getTreeInfo()
NodeInfo
getTreeInfo
in interface NodeInfo
public final java.lang.Object getRealNode()
getRealNode
in interface VirtualNode
public NamePool getNamePool()
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 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 int hashCode()
hashCode
in interface NodeInfo
hashCode
in class java.lang.Object
public java.lang.String getSystemId()
getSystemId
in interface javax.xml.transform.Source
getSystemId
in interface javax.xml.transform.SourceLocator
getSystemId
in interface NodeInfo
getSystemId
in interface Location
getSystemId
in interface org.xml.sax.Locator
public void setSystemId(java.lang.String uri)
setSystemId
in interface javax.xml.transform.Source
uri
- the system ID.public java.lang.String getBaseURI()
getBaseURI
in interface NodeInfo
public int getLineNumber()
getLineNumber
in interface javax.xml.transform.SourceLocator
getLineNumber
in interface NodeInfo
getLineNumber
in interface Location
getLineNumber
in interface org.xml.sax.Locator
public int getColumnNumber()
getColumnNumber
in interface javax.xml.transform.SourceLocator
getColumnNumber
in interface NodeInfo
getColumnNumber
in interface Location
getColumnNumber
in interface org.xml.sax.Locator
public Location saveLocation()
saveLocation
in interface Location
public java.lang.String getStringValue()
getStringValue
in interface GroundedValue
getStringValue
in interface Item
getStringValue
in interface NodeInfo
Item.getStringValueCS()
public java.lang.String getDisplayName()
getDisplayName
in interface NodeInfo
public java.lang.String getAttributeValue(java.lang.String uri, java.lang.String local)
The default implementation is suitable for nodes other than elements.
getAttributeValue
in interface NodeInfo
uri
- the namespace URI of the attribute name. Supply the empty string for an attribute
that is in no namespacelocal
- the local part of the attribute name.public AxisIterator iterateAxis(int axisNumber)
iterateAxis
in interface NodeInfo
axisNumber
- the axis to be usedAxisInfo
public AxisIterator iterateAxis(int axisNumber, java.util.function.Predicate<? super NodeInfo> nodeTest)
This superclass provides implementations of the ancestor, ancestor-or-self, following, namespace, parent, preceding, self, and preceding-or-ancestor axes. The other axes are implemented by calling methods iterateAttributes(), iterateChildren(), iterateDescendants(), and iterateSiblings(), which must be provided in a subclass.
iterateAxis
in interface NodeInfo
axisNumber
- the axis to be usednodeTest
- A pattern to be matched by the returned nodesAxisInfo
protected abstract AxisIterator iterateAttributes(java.util.function.Predicate<? super NodeInfo> nodeTest)
nodeTest
- a test that the returned attributes must satisfyprotected abstract AxisIterator iterateChildren(java.util.function.Predicate<? super NodeInfo> nodeTest)
nodeTest
- a test that the returned attributes must satisfyprotected abstract AxisIterator iterateSiblings(java.util.function.Predicate<? super NodeInfo> nodeTest, boolean forwards)
nodeTest
- a test that the returned siblings must satisfyforwards
- true for following siblings, false for preceding siblingsprotected AxisIterator iterateDescendants(java.util.function.Predicate<? super NodeInfo> nodeTest, boolean includeSelf)
nodeTest
- a test that the returned descendants must satisfyincludeSelf
- true if this node is to be included in the resultpublic NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
This method is intended primarily for internal use. User applications needing
information about the namespace context of a node should use iterateAxis(Axis.NAMESPACE)
.
(However, not all implementations support the namespace axis, whereas all implementations are
required to support this method.)
This implementation of the method is suitable for all nodes other than elements; it returns an empty array.
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 NamespaceMap getAllNamespaces()
For an element return all the prefix-to-uri bindings that are in scope. This may include a binding to the default namespace (represented by a prefix of ""). It will never include "undeclarations" - that is, the namespace URI will never be empty; the effect of an undeclaration is to remove a binding from the in-scope namespaces, not to add anything.
For a node other than an element, returns null.
getAllNamespaces
in interface NodeInfo
public NodeInfo getRoot()
public boolean hasChildNodes()
hasChildNodes
in interface NodeInfo
public int getFingerprint()
getFingerprint
in interface NodeInfo
java.lang.UnsupportedOperationException
- if this method is called for a node where
hasFingerprint() returns false;public boolean hasFingerprint()
hasFingerprint
in interface NodeInfo
Copyright (c) 2004-2022 Saxonica Limited. All rights reserved.