net.sf.saxon.tinytree

Class TinyElementImpl

public final class TinyElementImpl extends TinyParentNodeImpl

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

Constructor Summary
TinyElementImpl(TinyTree tree, int nodeNr)
Constructor - create a tiny element node
Method Summary
Valueatomize()
Get the typed value.
voidcopy(Receiver receiver, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given receiver
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
StringgetBaseURI()
Get the base URI of this element node.
int[]getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
static 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.
static int[]getInScopeNamespaces(TinyTree tree, int nodeNr, int[] buffer)
Get all the inscope namespaces for an element node.
intgetNodeKind()
Return the type of node.
intgetTypeAnnotation()
Get the type annotation of this node, if any Returns Type.UNTYPED_ANY if there is no type annotation
SequenceIteratorgetTypedValue()
Get the typed value of this node.
StringgetURIForPrefix(String prefix, boolean useDefault)
Get the namespace URI corresponding to a given prefix.
booleanisId()
Determine whether this node has the is-id property
booleanisIdref()
Determine whether this node has the is-idref property

Constructor Detail

TinyElementImpl

public TinyElementImpl(TinyTree tree, int nodeNr)
Constructor - create a tiny element node

Parameters: tree the Tinytree containing the node nodeNr the node number

Method Detail

atomize

public Value atomize()
Get the typed value. The result of this method will always be consistent with the method 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.

Returns: the typed value. It will be a Value representing a sequence whose items are atomic values.

Since: 8.5

copy

public void copy(Receiver receiver, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given receiver

Parameters: whichNamespaces indicates which namespaces should be copied: all, none, or local (i.e., those not declared on a parent element)

getAttributeValue

public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node

Parameters: fingerprint The fingerprint of the attribute name

Returns: the attribute value if it exists or null if not

getBaseURI

public String getBaseURI()
Get the base URI of this element node. This will be the same as the System ID unless xml:base has been used.

getDeclaredNamespaces

public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.

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

public static 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.

Parameters: tree The tree containing the given element node nodeNr The node number of the given element node within the tinyTree 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.

getInScopeNamespaces

public static int[] getInScopeNamespaces(TinyTree tree, int nodeNr, int[] buffer)
Get all the inscope namespaces for an element node. This method is better than the generic method provided by NamespaceIterator 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 required nodeNr the node number of the element node within the TinyTree. The caller is responsible for ensuring that this is indeed an element node buffer 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.

getNodeKind

public final int getNodeKind()
Return the type of node.

Returns: Type.ELEMENT

getTypeAnnotation

public int getTypeAnnotation()
Get the type annotation of this node, if any Returns Type.UNTYPED_ANY if there is no type annotation

getTypedValue

public SequenceIterator getTypedValue()
Get the typed value of this node. If there is no type annotation, we return the string value, as an instance of xs:untypedAtomic

getURIForPrefix

public String getURIForPrefix(String prefix, boolean useDefault)
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

Returns: true if the node is an ID

isIdref

public boolean isIdref()
Determine whether this node has the is-idref property

Returns: true if the node is an IDREF or IDREFS element or attribute