A StrippedNode is a view of a node, in a virtual tree that has whitespace
text nodes stripped from it. All operations on the node produce the same result
as operations on the real underlying node, except that iterations over the axes
take care to skip whitespace-only text nodes that are supposed to be stripped.
Note that this class is only used in cases where a pre-built tree is supplied as
the input to a transformation, and where the stylesheet does whitespace stripping;
if a SAXSource or StreamSource is supplied, whitespace is stripped as the tree
is built.
atomize
public Value atomize()
throws XPathException
Get the typed value. The result of this method will always be consistent with the method
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
- the typed value. If requireSingleton is set to true, the result will always be an
AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic
values.
compareOrder
public 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.
- compareOrder in interface NodeInfo
other
- The other node, whose position is to be compared with this node
- -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())
copy
public void copy(Receiver out,
int whichNamespaces,
boolean copyAnnotations,
int locationId)
throws XPathException
Copy this node to a given outputter (deep copy)
- copy in interface NodeInfo
equals
public boolean equals(Object other)
The equals() method compares nodes for identity. It is defined to give the same result
as isSameNodeInfo().
- equals in interface NodeInfo
other
- the node to be compared with this node
- true if this NodeInfo object and the supplied NodeInfo object represent
the same node in the tree.
- 8.7 Previously, the effect of the equals() method was not defined. Callers
should therefore be aware that third party implementations of the NodeInfo interface may
not implement the correct semantics. It is safer to use isSameNodeInfo() for this reason.
The equals() method has been defined because it is useful in contexts such as a Java Set or HashMap.
generateId
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
- generateId in interface NodeInfo
buffer
- a buffer, into which will be placed
a string that uniquely identifies this node, within this
document. The calling code prepends information to make the result
unique across all documents.
getAttributeValue
public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
- getAttributeValue in interface NodeInfo
fingerprint
- The fingerprint of the attribute name
- the attribute value if it exists or null if not
getBaseURI
public String getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained
in the node. In the JDOM model, base URIs are held only an the document level. We don't
currently take any account of xml:base attributes.
- getBaseURI in interface NodeInfo
getDeclaredNamespaces
public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
- 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.
- An array of integers representing the namespace declarations and undeclarations present on
this element. For a node other than an element, return null. Otherwise, the returned array is a
sequence of namespace codes, whose meaning may be interpreted by reference to the name pool. The
top half word of each namespace code represents the prefix, the bottom half represents the URI.
If the bottom half is zero, then this is a namespace undeclaration rather than a declaration.
The XML namespace is never included in the list. If the supplied array is larger than required,
then the first unused entry will be set to -1.
For a node other than an element, the method returns 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.
- getDisplayName in interface NodeInfo
- The display name of this node.
For a node with no name, return an empty string.
getDocumentNumber
public int getDocumentNumber()
Get the document number of the document containing this node. For a free-standing
orphan node, just return the hashcode.
- getDocumentNumber in interface NodeInfo
getFingerprint
public int getFingerprint()
Get fingerprint. The fingerprint is a coded form of the expanded name
of the node: two nodes
with the same name code have the same namespace URI and the same local name.
A fingerprint of -1 should be returned for a node with no name.
- getFingerprint in interface NodeInfo
getLineNumber
public int getLineNumber()
Get line number
- getLineNumber in interface NodeInfo
- the line number of the node in its original source document; or -1 if not available
getLocalPart
public String getLocalPart()
Get the local part of the name of this node. This is the name after the ":" if any.
- getLocalPart in interface NodeInfo
- the local part of the name. For an unnamed node, returns null, except for
un unnamed namespace node, which returns "".
getNameCode
public int getNameCode()
Get name code. The name code is a coded form of the node name: two nodes
with the same name code have the same namespace URI, the same local name,
and the same prefix. By masking the name code with &0xfffff, you get a
fingerprint: two nodes with the same fingerprint have the same local name
and namespace URI.
- getNameCode in interface NodeInfo
getNodeKind
public int getNodeKind()
Return the type of node.
- getNodeKind in interface NodeInfo
- one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
getParent
public NodeInfo getParent()
Get the NodeInfo object representing the parent of this node
- getParent in interface NodeInfo
getPrefix
public String getPrefix()
Get the prefix of the name of the node. This is defined only for elements and attributes.
If the node has no prefix, or for other kinds of node, return a zero-length string.
- getPrefix in interface NodeInfo
- The prefix of the name of the node.
getRoot
public NodeInfo getRoot()
Get the root node - always a document node with this tree implementation
- getRoot in interface NodeInfo
- the NodeInfo representing the containing document
getStringValue
public String getStringValue()
Return the string value of the node. The interpretation of this depends on the type
of node. For an element it is the accumulated character content of the element,
including descendant elements.
- getStringValue in interface NodeInfo
- getStringValue in interface Item
- getStringValue in interface ValueRepresentation
- the string value of the node
getSystemId
public String getSystemId()
Get the System ID for the node.
- getSystemId in interface NodeInfo
- 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.
getTypeAnnotation
public int getTypeAnnotation()
Get the type annotation
- getTypeAnnotation in interface NodeInfo
- 0 (there is no type annotation)
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.
- getURI in interface NodeInfo
- The URI of the namespace of this node. For an unnamed node, return null.
For a node with an empty prefix, return an empty string.
getUnderlyingNode
public Object getUnderlyingNode()
Get the underlying DOM node, to implement the VirtualNode interface
- getUnderlyingNode in interface VirtualNode
hasChildNodes
public boolean hasChildNodes()
Determine whether the node has any children.
Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()
- hasChildNodes in interface NodeInfo
hashCode
public 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()
- hashCode in interface NodeInfo
- 8.7 Previously, the effect of the equals() and hashCode() methods was not defined. Callers
should therefore be aware that third party implementations of the NodeInfo interface may
not implement the correct semantics.
isSameNodeInfo
public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)
- isSameNodeInfo in interface NodeInfo
- true if this Node object and the supplied Node object represent the
same node in the tree.
iterateAxis
public AxisIterator iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node
- iterateAxis in interface NodeInfo
axisNumber
- the axis to be used
- a SequenceIterator that scans the nodes reached by the axis in turn.
iterateAxis
public AxisIterator iterateAxis(byte axisNumber,
NodeTest nodeTest)
Return an iteration over the nodes reached by the given axis from this node
- iterateAxis in interface NodeInfo
axisNumber
- the axis to be usednodeTest
- A pattern to be matched by the returned nodes
- a SequenceIterator that scans the nodes reached by the axis in turn.
makeWrapper
protected StrippedNode makeWrapper(NodeInfo node,
StrippedDocument docWrapper,
StrippedNode parent)
Factory method to wrap a node with a wrapper that implements the Saxon
NodeInfo interface.
node
- The underlying nodedocWrapper
- The wrapper for the document node (must be supplied)parent
- The wrapper for the parent of the node (null if unknown)
- The new wrapper for the supplied node
setSystemId
public void setSystemId(String uri)