|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.saxon.xom.NodeWrapper
A node in the XML parse tree representing an XML element, character content, or attribute.
This is the implementation of the NodeInfo interface used as a wrapper for XOM nodes.
| Field Summary | |
protected DocumentWrapper |
docWrapper
|
protected int |
index
|
protected nu.xom.Node |
node
|
protected short |
nodeKind
|
| 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 | |
protected |
NodeWrapper(nu.xom.Node node,
NodeWrapper parent,
int index)
This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class |
| Method Summary | |
Value |
atomize()
Get the typed value. |
int |
compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order. |
void |
copy(Receiver out,
int whichNamespaces,
boolean copyAnnotations,
int locationId)
Copy this node to a given outputter (deep copy) |
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(int fingerprint)
Get the 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. |
Configuration |
getConfiguration()
Get the configuration |
int[] |
getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element. |
java.lang.String |
getDisplayName()
Get the display name of this node. |
int |
getDocumentNumber()
Get the document number of the document containing this node. |
DocumentInfo |
getDocumentRoot()
Get the root node, if it is a document node. |
int |
getFingerprint()
Get fingerprint. |
int |
getLineNumber()
Get line number |
java.lang.String |
getLocalPart()
Get the local part of the name of this node. |
int |
getNameCode()
Get name code. |
NamePool |
getNamePool()
Get the name pool for this node |
int |
getNodeKind()
Return the type of node. |
NodeInfo |
getParent()
Get the NodeInfo object representing the parent of this node |
java.lang.String |
getPrefix()
Get the prefix of the name of the node. |
NodeInfo |
getRoot()
Get the root node of the tree containing this node |
int |
getSiblingPosition()
Get the index position of this node among its siblings (starting from 0) |
java.lang.String |
getStringValue()
Return the string value of the node. |
java.lang.CharSequence |
getStringValueCS()
Get the value of the item as a CharSequence. |
java.lang.String |
getSystemId()
Get the System ID for the node. |
int |
getTypeAnnotation()
Get the type annotation of this node, if any. |
SequenceIterator |
getTypedValue()
Get the typed value of the item |
java.lang.Object |
getUnderlyingNode()
Get the underlying XOM node, to implement the VirtualNode interface |
java.lang.String |
getURI()
Get the URI part of the name of this node. |
boolean |
hasChildNodes()
Determine whether the node has any children. |
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() |
boolean |
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node. |
AxisIterator |
iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node |
AxisIterator |
iterateAxis(byte axisNumber,
NodeTest nodeTest)
Return an iteration over the nodes reached by the given axis from this node |
protected NodeWrapper |
makeWrapper(nu.xom.Node node,
DocumentWrapper docWrapper)
Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface. |
protected NodeWrapper |
makeWrapper(nu.xom.Node node,
DocumentWrapper docWrapper,
NodeWrapper parent,
int index)
Factory method to wrap a XOM node with a wrapper that implements the Saxon NodeInfo interface. |
void |
sendNamespaceDeclarations(Receiver out,
boolean includeAncestors)
Output all namespace nodes associated with this element. |
void |
setSystemId(java.lang.String uri)
|
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
protected nu.xom.Node node
protected short nodeKind
protected DocumentWrapper docWrapper
protected int index
| Constructor Detail |
protected NodeWrapper(nu.xom.Node node,
NodeWrapper parent,
int index)
node - The XOM node to be wrappedparent - The NodeWrapper that wraps the parent of this nodeindex - Position of this node among its siblings| Method Detail |
protected final NodeWrapper makeWrapper(nu.xom.Node node,
DocumentWrapper docWrapper)
node - The XOM nodedocWrapper - The wrapper for the Document containing this node
protected final NodeWrapper makeWrapper(nu.xom.Node node,
DocumentWrapper docWrapper,
NodeWrapper parent,
int index)
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
public Configuration getConfiguration()
getConfiguration in interface NodeInfopublic java.lang.Object getUnderlyingNode()
getUnderlyingNode in interface VirtualNodepublic NamePool getNamePool()
getNamePool in interface NodeInfopublic int getNodeKind()
getNodeKind in interface NodeInfoTypepublic SequenceIterator getTypedValue()
getTypedValue in interface Itempublic Value atomize()
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 NodeInfopublic int getTypeAnnotation()
getTypeAnnotation in interface NodeInfoTypepublic boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo in interface NodeInfoother - the node to be compared with this node
public boolean equals(java.lang.Object other)
equals in interface NodeInfoother - the node to be compared with this node
public int hashCode()
hashCode in interface NodeInfopublic java.lang.String getSystemId()
getSystemId in interface NodeInfopublic void setSystemId(java.lang.String uri)
setSystemId in interface javax.xml.transform.Sourcepublic java.lang.String getBaseURI()
getBaseURI in interface NodeInfopublic int getLineNumber()
getLineNumber in interface NodeInfopublic int compareOrder(NodeInfo other)
compareOrder in interface NodeInfoother - The other node, whose position is to be compared with this
node
public java.lang.String getStringValue()
getStringValue in interface NodeInfopublic java.lang.CharSequence getStringValueCS()
getStringValueCS in interface ItemItem.getStringValue()public int getNameCode()
getNameCode in interface NodeInfoallocatepublic int getFingerprint()
getFingerprint in interface NodeInfopublic java.lang.String getLocalPart()
getLocalPart in interface NodeInfopublic java.lang.String getPrefix()
getPrefix in interface NodeInfopublic java.lang.String getURI()
getURI in interface NodeInfopublic java.lang.String getDisplayName()
getDisplayName in interface NodeInfopublic NodeInfo getParent()
getParent in interface NodeInfopublic int getSiblingPosition()
getSiblingPosition in interface SiblingCountingNodepublic AxisIterator iterateAxis(byte axisNumber)
iterateAxis in interface NodeInfoaxisNumber - the axis to be used
Axis
public AxisIterator iterateAxis(byte axisNumber,
NodeTest nodeTest)
iterateAxis in interface NodeInfoaxisNumber - the axis to be usednodeTest - A pattern to be matched by the returned nodes
Axispublic java.lang.String getAttributeValue(int fingerprint)
getAttributeValue in interface NodeInfofingerprint - The fingerprint of the attribute name
public NodeInfo getRoot()
getRoot in interface NodeInfopublic DocumentInfo getDocumentRoot()
getDocumentRoot in interface NodeInfopublic boolean hasChildNodes()
hasChildNodes in interface NodeInfopublic void generateId(FastStringBuffer buffer)
generateId in interface NodeInfobuffer - a buffer to contain a string that uniquely identifies this node, across all documentspublic int getDocumentNumber()
getDocumentNumber in interface NodeInfo
public void copy(Receiver out,
int whichNamespaces,
boolean copyAnnotations,
int locationId)
throws XPathException
copy in interface NodeInfoout - the Receiver to which the node should be copiedwhichNamespaces - in the case of an element, controls
which namespace nodes should be copied. Values are NodeInfo.NO_NAMESPACES,
NodeInfo.LOCAL_NAMESPACES, NodeInfo.ALL_NAMESPACEScopyAnnotations - indicates whether the type annotations
of element and attribute nodes should be copiedlocationId - If non-zero, identifies the location of the instruction
that requested this copy. If zero, indicates that the location information
for the original node is to be copied; in this case the Receiver must be
a LocationCopier
XPathException
public void sendNamespaceDeclarations(Receiver out,
boolean includeAncestors)
throws XPathException
sendNamespaceDeclarations in interface NodeInfoout - The relevant outputterincludeAncestors - True if namespaces declared on ancestor elements must be
XPathExceptionpublic int[] getDeclaredNamespaces(int[] buffer)
getDeclaredNamespaces in interface NodeInfobuffer - 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.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||