|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.option.dom4j.NodeWrapper
public class 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 DOM4J nodes.
| Field Summary | |
|---|---|
protected DocumentWrapper |
docWrapper
|
protected int |
index
|
protected Object |
node
|
protected short |
nodeKind
|
| Fields inherited from interface net.sf.saxon.om.NodeInfo |
|---|
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES |
| Constructor Summary | |
|---|---|
protected |
NodeWrapper(Object 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 copyOptions,
int locationId)
Copy this node to a given outputter (deep copy) |
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 local)
Get the string value of a given attribute of this node |
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 |
Configuration |
getConfiguration()
Get the configuration used to build the tree containing this node. |
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 fingerprint. |
int |
getLineNumber()
Get line number |
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 |
String |
getPrefix()
Get the prefix part of the name of this node. |
Object |
getRealNode()
Get the node underlying this virtual node. |
NodeInfo |
getRoot()
Get the root node - always a document node with this tree implementation |
SchemaType |
getSchemaType()
Get the type annotation of this node, if any. |
int |
getSiblingPosition()
Get the index position of this node among its siblings (starting from 0) |
String |
getStringValue()
Return the string value of the node. |
CharSequence |
getStringValueCS()
Get the string value of the item as a CharSequence. |
String |
getSystemId()
Get the System ID for the node. |
int |
getTypeAnnotation()
Get the type annotation |
SequenceIterator |
getTypedValue()
Get the typed value of the item |
Object |
getUnderlyingNode()
Get the underlying DOM node, to implement the VirtualNode interface |
String |
getURI()
Get the URI part of the name of this node. |
boolean |
hasChildNodes()
Determine whether the node has any children. |
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 |
isSameNode(NodeInfo other)
Determine whether this is the same node as another node. |
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(Object node,
DocumentWrapper docWrapper)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon NodeInfo interface. |
protected NodeWrapper |
makeWrapper(Object node,
DocumentWrapper docWrapper,
NodeWrapper parent,
int index)
Factory method to wrap a DOM4J node with a wrapper that implements the Saxon NodeInfo interface. |
void |
setSystemId(String uri)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface net.sf.saxon.om.NodeInfo |
|---|
equals, hashCode |
| Field Detail |
|---|
protected Object node
protected short nodeKind
protected DocumentWrapper docWrapper
protected int index
| Constructor Detail |
|---|
protected NodeWrapper(Object node,
NodeWrapper parent,
int index)
node - The DOM4J node to be wrappedparent - The NodeWrapper that wraps the parent of this nodeindex - Position of this node among its siblings| Method Detail |
|---|
protected NodeWrapper makeWrapper(Object node,
DocumentWrapper docWrapper)
node - The DOM4J nodedocWrapper - The wrapper for the Document containing this node
protected NodeWrapper makeWrapper(Object node,
DocumentWrapper docWrapper,
NodeWrapper parent,
int index)
node - The DOM4J nodedocWrapper - The wrapper for the Document containing this nodeparent - The wrapper for the parent of the DOM4J nodeindex - The position of this node relative to its siblings
public Object getUnderlyingNode()
getUnderlyingNode in interface VirtualNodepublic Object getRealNode()
getRealNode in interface VirtualNodepublic NamePool getNamePool()
getNamePool in interface NodeInfopublic int getNodeKind()
getNodeKind in interface NodeInfoTypepublic SequenceIterator getTypedValue()
getTypedValue in interface Item<NodeInfo>public Value atomize()
NodeInfoItem.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 NodeInfoFor elements and attributes, this is the type annotation as defined in XDM. For document nodes, it should be one of XS_UNTYPED if the document has not been validated, or XS_ANY_TYPE if validation has taken place (that is, if any node in the document has an annotation other than Untyped or UntypedAtomic).
public SchemaType getSchemaType()
Types derived from a DTD are not reflected in the result of this method.
getSchemaType in interface NodeInfopublic boolean isSameNode(NodeInfo other)
other - the node to be compared with
public String getSystemId()
getSystemId in interface SourcegetSystemId in interface NodeInfopublic void setSystemId(String uri)
setSystemId in interface Sourcepublic String getBaseURI()
getBaseURI in interface NodeInfopublic int getLineNumber()
getLineNumber in interface NodeInfopublic int getColumnNumber()
getColumnNumber in interface NodeInfopublic int compareOrder(NodeInfo other)
compareOrder in interface NodeInfoother - The other node, whose position is to be compared with this node
public String getStringValue()
getStringValue in interface Item<NodeInfo>getStringValue in interface NodeInfogetStringValue in interface ValueRepresentation<NodeInfo>Item.getStringValueCS()public CharSequence getStringValueCS()
ItemX.getStringValueCS().toString() returns a string that is equal to
X.getStringValue().
Note that two CharSequence values of different types should not be compared using equals(), and for the same reason they should not be used as a key in a hash table.
If the calling code can handle any CharSequence, this method should
be used. If the caller requires a string, the Item.getStringValue() method is preferred.
getStringValueCS in interface Item<NodeInfo>getStringValueCS in interface ValueRepresentation<NodeInfo>Item.getStringValue()public int getNameCode()
getNameCode in interface NodeInfoallocatepublic int getFingerprint()
getFingerprint in interface NodeInfopublic String getLocalPart()
getLocalPart in interface NodeInfopublic String getPrefix()
getPrefix in interface NodeInfopublic String getURI()
getURI in interface NodeInfopublic 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 String getAttributeValue(int fingerprint)
getAttributeValue in interface NodeInfofingerprint - The fingerprint of the attribute name
public String getAttributeValue(String uri,
String local)
getAttributeValue in interface NodeInfouri - 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 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 long getDocumentNumber()
getDocumentNumber in interface NodeInfo
public void copy(Receiver out,
int copyOptions,
int locationId)
throws XPathException
copy in interface NodeInfoout - the Receiver to which the node should be copied. It is the caller's
responsibility to ensure that this Receiver is open before the method is called
(or that it is self-opening), and that it is closed after use.copyOptions - a selection of the options defined in CopyOptionslocationId - If non-zero, identifies the location of the instruction
that requested this copy. If zero, indicates that the location information
XPathException - if any downstream error occurspublic boolean isId()
isId in interface NodeInfopublic boolean isIdref()
isIdref in interface NodeInfopublic boolean isNilled()
isNilled in interface NodeInfopublic boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo in interface NodeInfoother - the node to be compared with this node
public Configuration getConfiguration()
NodeInfo
getConfiguration in interface NodeInfopublic NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] 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 | ||||||||