net.sf.saxon.tinytree
Class TinyElementImpl

java.lang.Object
  extended bynet.sf.saxon.tinytree.TinyNodeImpl
      extended bynet.sf.saxon.tinytree.TinyParentNodeImpl
          extended bynet.sf.saxon.tinytree.TinyElementImpl
All Implemented Interfaces:
FingerprintedNode, Item, NodeInfo, javax.xml.transform.Source, javax.xml.transform.SourceLocator, ValueRepresentation

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

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, LOCAL_NAMESPACES, NO_NAMESPACES
 
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
 
Constructor Summary
TinyElementImpl(TinyTree tree, int nodeNr)
          Constructor
 
Method Summary
 void copy(Receiver receiver, int whichNamespaces, boolean copyAnnotations, int locationId)
          Copy this node to a given receiver
 java.lang.String getAttributeValue(int fingerprint)
          Get the value of a given attribute of this node
 java.lang.String getBaseURI()
          Get the base URI of this element node.
 int[] getDeclaredNamespaces(int[] buffer)
          Get all namespace undeclarations and undeclarations defined on this element.
(package private) 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.
(package private) static int[] getInScopeNamespaces(TinyTree tree, int nodeNr, int[] buffer)
          Get all the inscope namespaces for an element node.
 int getNodeKind()
          Return the type of node.
 java.lang.String getStringValue()
          Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
static java.lang.CharSequence getStringValue(TinyTree tree, int nodeNr)
          Get the string value of a node.
 java.lang.CharSequence getStringValueCS()
          Get the value of the item as a CharSequence.
 int getTypeAnnotation()
          Get the type annotation of this node, if any Returns Type.UNTYPED_ANY if there is no type annotation
 java.lang.String getURIForPrefix(java.lang.String prefix, boolean useDefault)
          Get the namespace URI corresponding to a given prefix.
 boolean hasChildNodes()
          Determine if the node has children.
 void sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
          Output all namespace nodes associated with this element.
 
Methods inherited from class net.sf.saxon.tinytree.TinyNodeImpl
atomize, compareOrder, equals, generateId, getColumnNumber, getConfiguration, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNamePool, getParent, getParentNodeNr, getPrefix, getPublicId, getRoot, getSequenceNumber, getSystemId, getTypedValue, getURI, hashCode, isAncestorOrSelf, isSameNodeInfo, iterateAxis, iterateAxis, setParentNode, setSystemId
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TinyElementImpl

public TinyElementImpl(TinyTree tree,
                       int nodeNr)
Constructor

Method Detail

getNodeKind

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

Returns:
Type.ELEMENT
See Also:
Type

getBaseURI

public java.lang.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.

Specified by:
getBaseURI in interface NodeInfo
Overrides:
getBaseURI in class TinyNodeImpl

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 interface NodeInfo
Overrides:
getTypeAnnotation in class TinyNodeImpl

sendNamespaceDeclarations

public void sendNamespaceDeclarations(Receiver out,
                                      boolean includeAncestors)
                               throws XPathException
Output all namespace nodes associated with this element.

Specified by:
sendNamespaceDeclarations in interface NodeInfo
Overrides:
sendNamespaceDeclarations in class TinyNodeImpl
Parameters:
out - The relevant outputter
includeAncestors - 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 interface NodeInfo
Overrides:
getDeclaredNamespaces in class TinyNodeImpl
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 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.

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

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

getAttributeValue

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

Specified by:
getAttributeValue in interface NodeInfo
Overrides:
getAttributeValue in class TinyNodeImpl
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:
whichNamespaces - indicates which namespaces should be copied: all, none, or local (i.e., those not declared on a parent element)
receiver - the Receiver to which the node should be copied
copyAnnotations - indicates whether the type annotations of element and attribute nodes should be copied
locationId - 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

public java.lang.String getURIForPrefix(java.lang.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 "".

hasChildNodes

public final boolean hasChildNodes()
Determine if the node has children.

Specified by:
hasChildNodes in interface NodeInfo
Overrides:
hasChildNodes in class TinyNodeImpl
Returns:
true if this node has any attributes, false otherwise.

getStringValue

public final java.lang.String getStringValue()
Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.

Returns:
the accumulated character content of the element, including descendant elements.

getStringValueCS

public java.lang.CharSequence getStringValueCS()
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.

Specified by:
getStringValueCS in interface Item
Overrides:
getStringValueCS in class TinyNodeImpl

getStringValue

public static final java.lang.CharSequence getStringValue(TinyTree tree,
                                                          int nodeNr)
Get the string value of a node. This static method allows the string value of a node to be obtained without instantiating the node as a Java object. The method also returns a CharSequence rather than a string, which means it can sometimes avoid copying the data.

Parameters:
tree - The containing document
nodeNr - identifies the node whose string value is required. This must be a document or element node. The caller is trusted to ensure this.
Returns:
the string value of the node, as a CharSequence