|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.option.jdom.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 JDOM 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) |
boolean |
equals(Object other)
The equals() method compares nodes for identity. |
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 |
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) In the case of a text node that maps to several adjacent siblings in the JDOM, the numbering actually refers to the position of the underlying JDOM nodes; thus the sibling position for the text node is that of the first JDOM node to which it relates, and the numbering of subsequent XPath nodes is not necessarily consecutive. |
String |
getStringValue()
Return the string value of the node. |
CharSequence |
getStringValueCS()
Get the 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 JDOM 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. |
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 |
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 |
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 JDOM 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 JDOM node with a wrapper that implements the Saxon NodeInfo interface. |
void |
setSystemId(String uri)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
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 JDOM node to be wrappedparent
- The NodeWrapper that wraps the parent of this nodeindex
- Position of this node among its siblingsMethod Detail |
---|
protected NodeWrapper makeWrapper(Object node, DocumentWrapper docWrapper)
node
- The JDOM nodedocWrapper
- The wrapper for the Document containing this node
protected NodeWrapper makeWrapper(Object node, DocumentWrapper docWrapper, NodeWrapper parent, int index)
node
- The JDOM nodedocWrapper
- The wrapper for the Document containing this nodeparent
- The wrapper for the parent of the JDOM nodeindex
- The position of this node relative to its siblings
public Object getUnderlyingNode()
getUnderlyingNode
in interface VirtualNode
public Object getRealNode()
getRealNode
in interface VirtualNode
public Configuration getConfiguration()
getConfiguration
in interface NodeInfo
public NamePool getNamePool()
getNamePool
in interface NodeInfo
public int getNodeKind()
getNodeKind
in interface NodeInfo
Type
public SequenceIterator getTypedValue()
getTypedValue
in interface Item<NodeInfo>
public 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 NodeInfo
public int getTypeAnnotation()
getTypeAnnotation
in interface NodeInfo
For 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 NodeInfo
public boolean isSameNodeInfo(NodeInfo other)
isSameNodeInfo
in interface NodeInfo
other
- the node to be compared with this node
public boolean equals(Object other)
equals
in interface NodeInfo
equals
in class Object
other
- the node to be compared with this node
public int hashCode()
hashCode
in interface NodeInfo
hashCode
in class Object
public String getSystemId()
getSystemId
in interface Source
getSystemId
in interface NodeInfo
public void setSystemId(String uri)
setSystemId
in interface Source
public String getBaseURI()
getBaseURI
in interface NodeInfo
public int getLineNumber()
getLineNumber
in interface NodeInfo
public int getColumnNumber()
getColumnNumber
in interface NodeInfo
public int compareOrder(NodeInfo other)
compareOrder
in interface NodeInfo
other
- The other node, whose position is to be compared with this node
public String getStringValue()
getStringValue
in interface Item<NodeInfo>
getStringValue
in interface NodeInfo
getStringValue
in interface ValueRepresentation<NodeInfo>
Item.getStringValueCS()
public CharSequence getStringValueCS()
getStringValueCS
in interface Item<NodeInfo>
getStringValueCS
in interface ValueRepresentation<NodeInfo>
Item.getStringValue()
public int getNameCode()
getNameCode
in interface NodeInfo
allocate
public int getFingerprint()
getFingerprint
in interface NodeInfo
public String getLocalPart()
getLocalPart
in interface NodeInfo
public String getPrefix()
getPrefix
in interface NodeInfo
public String getURI()
getURI
in interface NodeInfo
public String getDisplayName()
getDisplayName
in interface NodeInfo
public NodeInfo getParent()
getParent
in interface NodeInfo
public int getSiblingPosition()
getSiblingPosition
in interface SiblingCountingNode
public AxisIterator iterateAxis(byte axisNumber)
iterateAxis
in interface NodeInfo
axisNumber
- the axis to be used
Axis
public AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
iterateAxis
in interface NodeInfo
axisNumber
- the axis to be usednodeTest
- A pattern to be matched by the returned nodes
Axis
public String getAttributeValue(int fingerprint)
getAttributeValue
in interface NodeInfo
fingerprint
- The fingerprint of the attribute name
public String getAttributeValue(String uri, String local)
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 NodeInfo getRoot()
getRoot
in interface NodeInfo
public DocumentInfo getDocumentRoot()
getDocumentRoot
in interface NodeInfo
public boolean hasChildNodes()
hasChildNodes
in interface NodeInfo
public void generateId(FastStringBuffer buffer)
generateId
in interface NodeInfo
buffer
- 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 NodeInfo
out
- 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 CopyOptions
locationId
- 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 NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)
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 boolean isId()
isId
in interface NodeInfo
public boolean isIdref()
isIdref
in interface NodeInfo
public boolean isNilled()
isNilled
in interface NodeInfo
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |