Package net.sf.saxon.tinytree
Class TinyElementImpl
java.lang.Object
net.sf.saxon.tinytree.TinyNodeImpl
net.sf.saxon.tinytree.TinyParentNodeImpl
net.sf.saxon.tinytree.TinyElementImpl
- All Implemented Interfaces:
Source
,SourceLocator
,ExtendedNodeInfo
,FingerprintedNode
,Item
,NodeInfo
,ValueRepresentation
A node in the XML parse tree representing an XML element.
This class is an implementation of NodeInfo. The object is a wrapper around one entry in the arrays maintained by the TinyTree. Note that the same node might be represented by different TinyElementImpl objects at different times.
- Author:
- Michael H. Kay
-
Field Summary
Fields inherited from class net.sf.saxon.tinytree.TinyNodeImpl
NODE_LETTER, nodeNr, parent, tree
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Copy this node to a given receivergetAttributeValue
(int fingerprint) Get the value of a given attribute of this nodeGet the base URI of this element node.int[]
getDeclaredNamespaces
(int[] buffer) Get all namespace undeclarations and undeclarations defined on this element.(package private) static final int[]
getDeclaredNamespaces
(TinyTree tree, int nodeNr, int[] buffer) Static method to get all namespace undeclarations and undeclarations defined on a given element, without instantiating the node object.(package private) static final int[]
getInScopeNamespaces
(TinyTree tree, int nodeNr, int[] buffer) Get all the inscope namespaces for an element node.final int
Return the type of node.int
Get the type annotation of this node, if any Returns Type.UNTYPED_ANY if there is no type annotationgetURIForPrefix
(String prefix, boolean useDefault) Get the namespace URI corresponding to a given prefix.boolean
isId()
Determine whether this node has the is-id propertyboolean
isIdref()
Determine whether this node has the is-idref propertyvoid
sendNamespaceDeclarations
(Receiver out, boolean includeAncestors) Output all namespace nodes associated with this element.Methods inherited from class net.sf.saxon.tinytree.TinyParentNodeImpl
getStringValue, getStringValue, getStringValueCS, hasChildNodes
Methods inherited from class net.sf.saxon.tinytree.TinyNodeImpl
atomize, compareOrder, equals, generateId, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNamePool, getNodeNumber, getParent, getParentNodeNr, getPrefix, getPublicId, getRoot, getSequenceNumber, getSystemId, getTypedValue, getURI, hashCode, isAncestorOrSelf, isNilled, isSameNodeInfo, iterateAxis, iterateAxis, setParentNode, setSystemId
-
Constructor Details
-
TinyElementImpl
Constructor
-
-
Method Details
-
getNodeKind
public final int getNodeKind()Return the type of node.- Returns:
- Type.ELEMENT
- See Also:
-
getBaseURI
Get the base URI of this element node. This will be the same as the System ID unless xml:base has been used.- Specified by:
getBaseURI
in interfaceNodeInfo
- Overrides:
getBaseURI
in classTinyNodeImpl
- Returns:
- the base URI of the node. This may be null if the base URI is unknown.
-
getTypeAnnotation
public int getTypeAnnotation()Get the type annotation of this node, if any Returns Type.UNTYPED_ANY if there is no type annotation- Specified by:
getTypeAnnotation
in interfaceNodeInfo
- Overrides:
getTypeAnnotation
in classTinyNodeImpl
- Returns:
- the type annotation of the node, under the mask NamePool.FP_MASK, and optionally the
bit setting IS_DTD_TYPE in the case of a DTD-derived ID or IDREF/S type (which is treated
as untypedAtomic for the purposes of obtaining the typed value).
The result is undefined for nodes other than elements and attributes.
-
sendNamespaceDeclarations
Output all namespace nodes associated with this element.- Specified by:
sendNamespaceDeclarations
in interfaceNodeInfo
- Overrides:
sendNamespaceDeclarations
in classTinyNodeImpl
- Parameters:
out
- The relevant outputterincludeAncestors
- True if namespaces associated with ancestor- Throws:
XPathException
-
getDeclaredNamespaces
public int[] getDeclaredNamespaces(int[] buffer) Get all namespace undeclarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespaces
in interfaceNodeInfo
- Overrides:
getDeclaredNamespaces
in classTinyNodeImpl
- 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.
-
getDeclaredNamespaces
Static method to get all namespace undeclarations and undeclarations defined on a given element, without instantiating the node object.- Parameters:
tree
- The tree containing the given element nodenodeNr
- The node number of the given element node within the tinyTreebuffer
- 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.
-
getInScopeNamespaces
Get all the inscope namespaces for an element node. This method is better than the generic method provided byNamespaceIterator
because it doesn't require the element node (or its ancestors) to be instantiated as objects.- Parameters:
tree
- the TinyTree containing the element node whose in-scope namespaces are requirednodeNr
- the node number of the element node within the TinyTree. The caller is responsible for ensuring that this is indeed an element nodebuffer
- a buffer to hold the result, assuming it is large enough- Returns:
- an integer array of namespace codes representing the inscope namespaces of the given element. The returned array will either be fully used, or it will contain a -1 entry marking the effective end of the list of namespace codes. Note that only distinct declared namespaces are included in the result; it does not contain any entries for namespace undeclarations or for overridden declarations.
-
getAttributeValue
Get the value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Overrides:
getAttributeValue
in classTinyNodeImpl
- Parameters:
fingerprint
- The fingerprint of the attribute name- Returns:
- the attribute value if it exists or null if not
-
copy
public void copy(Receiver receiver, int whichNamespaces, boolean copyAnnotations, int locationId) throws XPathException Copy this node to a given receiver- Parameters:
receiver
- the Receiver to which the node should be copiedwhichNamespaces
- indicates which namespaces should be copied: all, none, or local (i.e., those not declared on a parent element)copyAnnotations
- 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- Throws:
XPathException
-
getURIForPrefix
Get the namespace URI corresponding to a given prefix. Return null if the prefix is not in scope.- Parameters:
prefix
- the namespace prefix. May be the zero-length string, indicating that there is no prefix. This indicates either the default namespace or the null namespace, depending on the value of useDefault.useDefault
- true if the default namespace is to be used when the prefix is "". If false, the method returns "" when the prefix is "".- Returns:
- the uri for the namespace, or null if the prefix is not in scope. The "null namespace" is represented by the pseudo-URI "".
-
isId
public boolean isId()Determine whether this node has the is-id property- Specified by:
isId
in interfaceExtendedNodeInfo
- Overrides:
isId
in classTinyNodeImpl
- Returns:
- true if the node is an ID
-
isIdref
public boolean isIdref()Determine whether this node has the is-idref property- Specified by:
isIdref
in interfaceExtendedNodeInfo
- Overrides:
isIdref
in classTinyNodeImpl
- Returns:
- true if the node is an IDREF or IDREFS element or attribute
-