Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.xom.NodeWrapper
public class NodeWrapper
extends java.lang.Object
implements NodeInfo, ExtendedNodeInfo, VirtualNode, SiblingCountingNode
Field Summary | |
protected DocumentWrapper | |
protected int | |
protected Node | |
protected short |
Fields inherited from interface net.sf.saxon.om.NodeInfo | |
ALL_NAMESPACES , EMPTY_NAMESPACE_LIST , IS_DTD_TYPE , IS_NILLED , LOCAL_NAMESPACES , NO_NAMESPACES |
Fields inherited from interface net.sf.saxon.om.ValueRepresentation | |
EMPTY_VALUE_ARRAY |
Constructor Summary | |
|
Method Summary | |
Value |
|
int |
|
void | |
boolean |
|
void |
|
String |
|
String |
|
Configuration |
|
int[] |
|
String |
|
int |
|
DocumentInfo |
|
int |
|
int |
|
String |
|
int |
|
NamePool |
|
int |
|
NodeInfo |
|
String |
|
NodeInfo |
|
int |
|
String |
|
CharSequence |
|
String |
|
int |
|
SequenceIterator |
|
String |
|
Object |
|
boolean |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
AxisIterator |
|
AxisIterator |
|
protected NodeWrapper |
|
protected NodeWrapper |
|
void |
|
protected NodeWrapper(Node node, NodeWrapper parent, int index)
This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class
- Parameters:
node
- The XOM node to be wrappedparent
- The NodeWrapper that wraps the parent of this nodeindex
- Position of this node among its siblings
public Value atomize()
Get the typed value. The result of this method will always be consistent with the methodItem.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.
- Returns:
- 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.
- Since:
- 8.5
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.
- Specified by:
- compareOrder in interface NodeInfo
- 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())
public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException
Copy this node to a given outputter (deep copy)
public boolean equals(Object other)
The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().
- Parameters:
other
- the node to be compared with this node
- Returns:
- true if this NodeInfo object and the supplied NodeInfo object represent the same node in the tree.
- Since:
- 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.
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)
- Specified by:
- generateId in interface NodeInfo
- Parameters:
buffer
- a buffer to contain a string that uniquely identifies this node, across all documents
public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
- Specified by:
- getAttributeValue in interface NodeInfo
- Parameters:
fingerprint
- The fingerprint of the attribute name
- Returns:
- the attribute value if it exists or null if not
public String getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.
- Specified by:
- getBaseURI in interface NodeInfo
public Configuration getConfiguration()
Get the configuration
- Specified by:
- getConfiguration in interface NodeInfo
public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
- Specified by:
- getDeclaredNamespaces in interface NodeInfo
- Parameters:
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.
- Returns:
- 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.
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
- Returns:
- The display name of this node. For a node with no name, return an empty string.
public int getDocumentNumber()
Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.
- Specified by:
- getDocumentNumber in interface NodeInfo
public DocumentInfo getDocumentRoot()
Get the root node, if it is a document node.
- Specified by:
- getDocumentRoot in interface NodeInfo
- Returns:
- the DocumentInfo representing the containing document.
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.
- Specified by:
- getFingerprint in interface NodeInfo
public int getLineNumber()
Get line number
- Specified by:
- getLineNumber in interface NodeInfo
- Returns:
- the line number of the node in its original source document; or -1 if not available
public String getLocalPart()
Get the local part of the name of this node. This is the name after the ":" if any.
- Specified by:
- getLocalPart in interface NodeInfo
- Returns:
- the local part of the name. For an unnamed node, returns "".
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.
- Specified by:
- getNameCode in interface NodeInfo
- See Also:
allocate
public NamePool getNamePool()
Get the name pool for this node
- Specified by:
- getNamePool in interface NodeInfo
- Returns:
- the NamePool
public int getNodeKind()
Return the type of node.
- Specified by:
- getNodeKind in interface NodeInfo
- Returns:
- one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.
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.
- Returns:
- The prefix of the name of the node.
public NodeInfo getRoot()
Get the root node of the tree containing this node
- Returns:
- the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node
public int getSiblingPosition()
Get the index position of this node among its siblings (starting from 0)
- Specified by:
- getSiblingPosition in interface SiblingCountingNode
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.
- Specified by:
- getStringValue in interface NodeInfo
- getStringValue in interface Item
- getStringValue in interface ValueRepresentation
- Returns:
- the string value of the node
public CharSequence getStringValueCS()
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.
- Specified by:
- getStringValueCS in interface Item
- getStringValueCS in interface ValueRepresentation
public String getSystemId()
Get the System ID for the node.
- Specified by:
- getSystemId in interface NodeInfo
- 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.
public int getTypeAnnotation()
Get the type annotation of this node, if any. Returns -1 for kinds of nodes that have no annotation, and for elements annotated as untyped, and attributes annotated as untypedAtomic.
- Specified by:
- getTypeAnnotation in interface NodeInfo
- Returns:
- the type annotation of the node.
- See Also:
Type
public SequenceIterator getTypedValue()
Get the typed value of the item
- Specified by:
- getTypedValue in interface Item
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.
- Returns:
- The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.
public Object getUnderlyingNode()
Get the underlying XOM node, to implement the VirtualNode interface
- Specified by:
- getUnderlyingNode in interface VirtualNode
public boolean hasChildNodes()
Determine whether the node has any children.
Note: the result is equivalent to
getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()
- Specified by:
- hasChildNodes in interface NodeInfo
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()
- Since:
- 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.
public boolean isId()
Determine whether this node has the is-id property
- Specified by:
- isId in interface ExtendedNodeInfo
- Returns:
- true if the node is an ID
public boolean isIdref()
Determine whether this node has the is-idref property
- Specified by:
- isIdref in interface ExtendedNodeInfo
- Returns:
- true if the node is an IDREF or IDREFS element or attribute
public boolean isNilled()
Determine whether the node has the is-nilled property
- Specified by:
- isNilled in interface ExtendedNodeInfo
- Returns:
- true if the node has the is-nilled property
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)
- Specified by:
- isSameNodeInfo in interface NodeInfo
- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
public AxisIterator iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node
- Specified by:
- iterateAxis in interface NodeInfo
- Parameters:
axisNumber
- the axis to be used
- Returns:
- a SequenceIterator that scans the nodes reached by the axis in turn.
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iteration over the nodes reached by the given axis from this node
- Specified by:
- iterateAxis in interface NodeInfo
- Parameters:
axisNumber
- the axis to be usednodeTest
- A pattern to be matched by the returned nodes
- Returns:
- a SequenceIterator that scans the nodes reached by the axis in turn.
protected final NodeWrapper makeWrapper(Node node, DocumentWrapper docWrapper)
Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.
- Parameters:
node
- The XOM nodedocWrapper
- The wrapper for the Document containing this node
- Returns:
- The new wrapper for the supplied node
protected final NodeWrapper makeWrapper(Node node, DocumentWrapper docWrapper, NodeWrapper parent, int index)
Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface.
- Parameters:
node
- The XOM nodedocWrapper
- The wrapper for the Document containing this nodeparent
- The wrapper for the parent of the XOM nodeindex
- The position of this node relative to its siblings
- Returns:
- The new wrapper for the supplied node
public void setSystemId(String uri)