Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
com.icl.saxon.om.AbstractNode
com.icl.saxon.tree.NodeImpl
public abstract class NodeImpl
extends AbstractNode
Field Summary | |
protected static NodeInfo[] | |
protected int | |
protected com.icl.saxon.tree.ParentNodeImpl |
Fields inherited from class com.icl.saxon.om.AbstractNode | |
NODE_LETTER |
Fields inherited from interface com.icl.saxon.om.NodeInfo | |
ATTRIBUTE , COMMENT , ELEMENT , NAMESPACE , NODE , NONE , NUMBER_OF_TYPES , PI , ROOT , TEXT |
Method Summary | |
int |
|
String |
|
String |
|
String |
|
NamedNodeMap |
|
String |
|
NodeList |
|
String |
|
Element |
|
DocumentInfo |
|
AxisEnumeration |
|
int |
|
Node |
|
Node |
|
int |
|
String |
|
int |
|
NamePool |
|
NodeImpl |
|
Node |
|
Node |
|
NodeInfo |
|
String |
|
NodeImpl |
|
Node |
|
protected long |
|
String |
|
String |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
public final 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
- Overrides:
- compareOrder in interface AbstractNode
- 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 String generateId()
Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)
- Specified by:
- generateId in interface NodeInfo
- Overrides:
- generateId in interface AbstractNode
- Returns:
- a string.
public String getAttributeValue(String uri, String localName)
Find the value of a given attribute of this node.
This method is defined on all nodes to meet XSL requirements, but for nodes other than elements it will always return null.
- Specified by:
- getAttributeValue in interface NodeInfo
- Overrides:
- getAttributeValue in interface AbstractNode
- Parameters:
uri
- the namespace uri of an attributelocalName
- the local name of an attribute
- Returns:
- the value of the attribute, if it exists, otherwise null
public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
- Specified by:
- getAttributeValue in interface NodeInfo
- Overrides:
- getAttributeValue in interface AbstractNode
- Parameters:
fingerprint
- The fingerprint of the attribute name
- Returns:
- the attribute value if it exists or null if not
public NamedNodeMap getAttributes()
Return aNamedNodeMap
containing the attributes of this node (if it is anElement
) ornull
otherwise. (DOM method)
- Overrides:
- getAttributes in interface AbstractNode
public String getBaseURI()
Get the base URI for the node. Default implementation for child nodes.
- Specified by:
- getBaseURI in interface NodeInfo
- Overrides:
- getBaseURI in interface AbstractNode
public NodeList getChildNodes()
Return aNodeList
that contains all children of this node. If there are no children, this is aNodeList
containing no nodes.
- Overrides:
- getChildNodes in interface AbstractNode
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
- Overrides:
- getDisplayName in interface AbstractNode
- Returns:
- The display name of this node. For a node with no name, return an empty string.
public Element getDocumentElement()
Get the outermost element.
- Overrides:
- getDocumentElement in interface AbstractNode
- Returns:
- the Element node for the outermost element of the document. If the document is not well-formed, this returns the last element child of the root if there is one, otherwise null.
public DocumentInfo getDocumentRoot()
Get the root (document) node
- Specified by:
- getDocumentRoot in interface NodeInfo
- Overrides:
- getDocumentRoot in interface AbstractNode
- Returns:
- the DocumentInfo representing the containing document
public AxisEnumeration getEnumeration(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node
- Specified by:
- getEnumeration in interface NodeInfo
- Overrides:
- getEnumeration in interface AbstractNode
- Parameters:
nodeTest
- A pattern to be matched by the returned nodes
- Returns:
- an AxisEnumeration that scans the nodes reached by the axis in turn.
public int getFingerprint()
Get the fingerprint of the node. This is used to compare whether two nodes have equivalent names. Return -1 for a node with no name.
- Specified by:
- getFingerprint in interface NodeInfo
- Overrides:
- getFingerprint in interface AbstractNode
public Node getFirstChild()
Get first child - default implementation used for leaf nodes
- Overrides:
- getFirstChild in interface AbstractNode
- Returns:
- null
public Node getLastChild()
Get last child - default implementation used for leaf nodes
- Overrides:
- getLastChild in interface AbstractNode
- Returns:
- null
public int getLineNumber()
Get the line number of the node within its source document entity
- Specified by:
- getLineNumber in interface NodeInfo
- Overrides:
- getLineNumber in interface AbstractNode
public String getLocalName()
Get the local name of this node.
- Specified by:
- getLocalName in interface NodeInfo
- Overrides:
- getLocalName in interface AbstractNode
- Returns:
- The local name of this node. For a node with no name, return an empty string.
public int getNameCode()
Get the nameCode of the node. This is used to locate the name in the NamePool
- Specified by:
- getNameCode in interface NodeInfo
- Overrides:
- getNameCode in interface AbstractNode
public NodeImpl getNextInDocument(NodeImpl anchor)
Get the next node in document order
- Parameters:
- Returns:
- the next node in the document, or null if there is no such node
public Node getNextSibling()
Get next sibling node
- Overrides:
- getNextSibling in interface AbstractNode
- Returns:
- The next sibling node of the required type. Returns null if the current node is the last child of its parent.
public Node getOriginatingNode()
Get the node corresponding to this javax.xml.transform.dom.DOMLocator
- Overrides:
- getOriginatingNode in interface AbstractNode
public final NodeInfo getParent()
Find the parent node of this node.
- Overrides:
- getParent in interface AbstractNode
- Returns:
- The Node object describing the containing element or root node.
public String getPrefix()
Get the prefix part of the name of this node. This is the name before the ":" if any.
- Overrides:
- getPrefix in interface AbstractNode
- Returns:
- the prefix part of the name. For an unnamed node, return an empty string.
public NodeImpl getPreviousInDocument()
Get the previous node in document order
- Returns:
- the previous node in the document, or null if there is no such node
public Node getPreviousSibling()
Get the previous sibling of the node
- Overrides:
- getPreviousSibling in interface AbstractNode
- Returns:
- The previous sibling node. Returns null if the current node is the first child of its parent.
protected long getSequenceNumber()
Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and roots) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position. This is the default implementation for child nodes.
public String getSystemId()
Get the system ID for the node. Default implementation for child nodes.
- Specified by:
- getSystemId in interface NodeInfo
- Overrides:
- getSystemId in interface AbstractNode
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.
- Overrides:
- getURI in interface AbstractNode
- Returns:
- The URI of the namespace of this node. For the default namespace, return an empty string. For an unnamed node, return null.
public boolean hasAttributes()
Returns whether this node (if it is an element) has any attributes.
- Overrides:
- hasAttributes in interface AbstractNode
- Returns:
true
if this node has any attributes,false
otherwise.
- Since:
- DOM Level 2
public boolean hasChildNodes()
Determine whether the node has any children.
- Specified by:
- hasChildNodes in interface NodeInfo
- Overrides:
- hasChildNodes in interface AbstractNode
- Returns:
true
if the node has any children,false
if the node has no children.
public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
- Specified by:
- isSameNodeInfo in interface NodeInfo
- Overrides:
- isSameNodeInfo in interface AbstractNode
- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
public void outputNamespaceNodes(Outputter out, boolean includeAncestors) throws TransformerException
Output all namespace nodes associated with this element. Does nothing if the node is not an element.
- Specified by:
- outputNamespaceNodes in interface NodeInfo
- Overrides:
- outputNamespaceNodes in interface AbstractNode
- Parameters:
out
- The relevant outputterincludeAncestors
- True if namespaces declared on ancestor elements must be output; false if it is known that these are already on the result tree
public void removeNode()
Remove this node from the tree. For system use only. When one or more nodes have been removed, renumberChildren() must be called to adjust the numbering of remaining nodes. PRECONDITION: The node must have a parent node.
public void setSystemId(String uri)
Set the system ID of this node. This method is provided so that a NodeInfo implements the javax.xml.transform.Source interface, allowing a node to be used directly as the Source of a transformation