net.sf.saxon.tinytree
Class TinyDocumentImpl

java.lang.Object
  |
  +--net.sf.saxon.om.AbstractNode
        |
        +--net.sf.saxon.tinytree.TinyNodeImpl
              |
              +--net.sf.saxon.tinytree.TinyParentNodeImpl
                    |
                    +--net.sf.saxon.tinytree.TinyDocumentImpl
All Implemented Interfaces:
org.w3c.dom.Document, DocumentInfo, javax.xml.transform.dom.DOMLocator, Item, org.w3c.dom.Node, NodeInfo, javax.xml.transform.Source, javax.xml.transform.SourceLocator

public final class TinyDocumentImpl
extends net.sf.saxon.tinytree.TinyParentNodeImpl
implements DocumentInfo, org.w3c.dom.Document

A node in the XML parse tree representing the Document itself (or equivalently, the root node of the Document).


Field Summary
protected  int[] alpha
           
protected  int[] attCode
           
protected  int[] attParent
           
protected  java.lang.CharSequence[] attValue
           
protected  int[] beta
           
protected  char[] charBuffer
           
protected  int charBufferLength
           
protected  java.lang.StringBuffer commentBuffer
           
protected  short[] depth
           
protected  TinyDocumentImpl document
           
protected  int[] nameCode
           
protected  int[] namespaceCode
           
protected  int[] namespaceParent
           
protected  int[] next
           
protected  byte[] nodeKind
           
protected  int nodeNr
           
protected  int numberOfAttributes
           
protected  int numberOfNamespaces
           
protected  int numberOfNodes
           
protected  net.sf.saxon.tinytree.TinyNodeImpl parent
           
protected  int[] prior
           
protected  int rootNode
           
 
Fields inherited from class net.sf.saxon.om.AbstractNode
NODE_LETTER
 
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, LOCAL_NAMESPACES, NO_NAMESPACES
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
TinyDocumentImpl()
           
TinyDocumentImpl(int nodes, int attributes, int namespaces, int characters)
           
 
Method Summary
protected  void addAttribute(int parent0, int code0, int type0, java.lang.CharSequence value0)
           
protected  void addNamespace(int parent, int nscode)
           
protected  int addNode(short kind, int depth0, int alpha0, int beta0, int nameCode0)
          Add a node to the document
protected  void appendChars(java.lang.CharSequence chars)
           
 int compareOrder(NodeInfo other)
          Determine the relative position of this node and another node, in document order.
 void condense()
          Condense the tree: release unused memory.
 void copy(Receiver out, int whichNamespaces, boolean copyAnnotations)
          Copy this node to a given outputter
 void diagnosticDump()
          Produce diagnostic print of main tree arrays
protected  void ensureAttributeCapacity()
           
protected  void ensureNamespaceCapacity()
           
protected  void ensureNodeCapacity()
           
protected  void ensurePriorIndex()
          On demand, make an index for quick access to preceding-sibling nodes
 java.lang.String generateId()
          Get a character string that uniquely identifies this node
protected  AxisIterator getAllElements(int fingerprint)
          Get a list of all elements with a given name.
protected  int getAttributeAnnotation(int nr)
          Get the type annotation of an attribute node.
protected  net.sf.saxon.tinytree.TinyAttributeImpl getAttributeNode(int nr)
          Make a (transient) attribute node from the array of attributes
 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 root node.
 java.lang.String getDisplayName()
          Get the display name of this node.
 int getDocumentNumber()
          Get the unique document number
 DocumentInfo getDocumentRoot()
          Get the root (document) node
protected  int getElementAnnotation(int nodeNr)
          Get the type annotation of an element node.
 int getFingerprint()
          Get the fingerprint of the node, used for matching names
 int getLineNumber()
          Get the line number of this root node.
protected  int getLineNumber(int sequence)
          Get the line number for an element.
 java.lang.String getLocalPart()
          Get the local name of this node.
 int getNameCode()
          Get the name code of the node, used for matching names
 NamePool getNamePool()
          Get the name pool used for the names in this document
protected  net.sf.saxon.tinytree.TinyNamespaceImpl getNamespaceNode(int nr)
          Make a (transient) namespace node from the array of namespace declarations
 net.sf.saxon.tinytree.TinyNodeImpl getNode(int nr)
           
 int getNodeKind()
          Return the type of node.
 org.w3c.dom.Node getOriginatingNode()
          Get the node corresponding to this javax.xml.transform.dom.DOMLocator
 NodeInfo getParent()
          Find the parent node of this node.
 java.lang.String getPrefix()
          Get the prefix part of the name of this node.
 NodeInfo getRoot()
          Get the root node
 long getSequenceNumber()
          Get the node sequence number (in document order).
 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.
 java.lang.String getSystemId()
          Get the system id of this root node
protected  java.lang.String getSystemId(int seq)
          Get the system id of an element in the document
 java.lang.String[] getUnparsedEntity(java.lang.String name)
          Get the unparsed entity with a given nameID if there is one, or null if not.
protected  UntypedAtomicValue getUntypedAtomicValue(int nodeNr)
          Get the typed value of a node.
 java.lang.String getURI()
          Get the URI part of the name of this node.
 boolean hasAttributes()
          Returns whether this node has any attributes.
 boolean hasChildNodes()
          Determine if the node has children.
 boolean isSameNode(NodeInfo other)
          Determine whether this is the same node as another node
protected  boolean isUsingNamespaces()
          determine whether this document uses namespaces
 AxisIterator iterateAxis(byte axisNumber)
          Return an iterator over all the nodes reached by the given axis from this node
 AxisIterator iterateAxis(byte axisNumber, NodeTest nodeTest)
          Return an iterator over the nodes reached by the given axis from this node
 void outputNamespaceNodes(Receiver out, boolean includeAncestors)
          Output all namespace nodes associated with this element.
 NodeInfo selectID(java.lang.String id)
          Get the element with a given ID.
protected  void setElementAnnotation(int nodeNr, int typeCode)
          Set the type annotation of an element node
protected  void setLineNumber(int sequence, int line)
          Set the line number for an element.
 void setLineNumbering()
          Set line numbering on
 void setNamePool(NamePool pool)
          Set the name pool used for all names in this document
protected  void setParentNode(net.sf.saxon.tinytree.TinyNodeImpl parent)
          Set the parent of this node.
 void setRootNode(NodeInfo root)
          Set the root node.
protected  void setSystemId(int seq, java.lang.String uri)
          Set the system id of an element in the document
 void setSystemId(java.lang.String uri)
          Set the system id of this node
protected  void setUnparsedEntity(java.lang.String name, java.lang.String uri, java.lang.String publicId)
          Set an unparsed entity URI associated with this document.
 void showSize()
           
 
Methods inherited from class net.sf.saxon.om.AbstractNode
appendChild, appendData, cloneNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getChildNodes, getColumnNumber, getData, getDoctype, getDocumentElement, getElementById, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getImplementation, getLastChild, getLength, getLocalName, getName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerElement, getParentNode, getPreviousSibling, getPublicId, getSpecified, getTagName, getTypeAnnotation, getTypedValue, getValue, hasAttribute, hasAttributeNS, importNode, insertBefore, insertData, isSupported, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, replaceChild, replaceData, setAttributeNode, setAttributeNodeNS, setAttributeNS, setData, setNodeValue, setPrefix, setValue, splitText, substringData, supports
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.saxon.om.NodeInfo
compareOrder, getAttributeValue, getDisplayName, getFingerprint, getLocalPart, getNameCode, getStringValue, getTypeAnnotation, getURI, hasChildNodes, isSameNode, iterateAxis, iterateAxis, outputNamespaceNodes
 
Methods inherited from interface net.sf.saxon.om.Item
getTypedValue
 
Methods inherited from interface org.w3c.dom.Document
createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getDoctype, getDocumentElement, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, importNode
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Field Detail

rootNode

protected int rootNode

charBuffer

protected char[] charBuffer

charBufferLength

protected int charBufferLength

commentBuffer

protected java.lang.StringBuffer commentBuffer

numberOfNodes

protected int numberOfNodes

nodeKind

protected byte[] nodeKind

depth

protected short[] depth

next

protected int[] next

alpha

protected int[] alpha

beta

protected int[] beta

nameCode

protected int[] nameCode

prior

protected int[] prior

numberOfAttributes

protected int numberOfAttributes

attParent

protected int[] attParent

attCode

protected int[] attCode

attValue

protected java.lang.CharSequence[] attValue

numberOfNamespaces

protected int numberOfNamespaces

namespaceParent

protected int[] namespaceParent

namespaceCode

protected int[] namespaceCode

document

protected TinyDocumentImpl document

nodeNr

protected int nodeNr

parent

protected net.sf.saxon.tinytree.TinyNodeImpl parent
Constructor Detail

TinyDocumentImpl

public TinyDocumentImpl()

TinyDocumentImpl

public TinyDocumentImpl(int nodes,
                        int attributes,
                        int namespaces,
                        int characters)
Method Detail

setNamePool

public void setNamePool(NamePool pool)
Set the name pool used for all names in this document

Specified by:
setNamePool in interface DocumentInfo
Parameters:
pool - The name pool to be used

getNamePool

public NamePool getNamePool()
Get the name pool used for the names in this document

Specified by:
getNamePool in interface DocumentInfo
Overrides:
getNamePool in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
the name pool in which all the names used in this document are registered

getDocumentNumber

public int getDocumentNumber()
Get the unique document number

Specified by:
getDocumentNumber in interface DocumentInfo
Overrides:
getDocumentNumber in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
the unique number identifying this document within the name pool

ensureNodeCapacity

protected void ensureNodeCapacity()

ensureAttributeCapacity

protected void ensureAttributeCapacity()

ensureNamespaceCapacity

protected void ensureNamespaceCapacity()

setRootNode

public void setRootNode(NodeInfo root)
Set the root node. Parentless elements are implemented using a full tree structure containing a document node, but the document node is not regarded as part of the tree


addNode

protected int addNode(short kind,
                      int depth0,
                      int alpha0,
                      int beta0,
                      int nameCode0)
Add a node to the document

Parameters:
kind - The kind of the node
depth0 - The depth in the tree
alpha0 - Pointer to attributes or text
beta0 - Pointer to namespaces or text
nameCode0 - The name of the node
Returns:
the node number of the node that was added

appendChars

protected void appendChars(java.lang.CharSequence chars)

condense

public void condense()
Condense the tree: release unused memory. This is done after the full tree has been built. The method makes a pragmatic judgement as to whether it is worth reclaiming space; this is only done when the constructed tree is very small compared with the space allocated.


setElementAnnotation

protected void setElementAnnotation(int nodeNr,
                                    int typeCode)
Set the type annotation of an element node


getElementAnnotation

protected int getElementAnnotation(int nodeNr)
Get the type annotation of an element node. Type.UNTYPED_ANY if there is no type annotation


ensurePriorIndex

protected void ensurePriorIndex()
On demand, make an index for quick access to preceding-sibling nodes


addAttribute

protected void addAttribute(int parent0,
                            int code0,
                            int type0,
                            java.lang.CharSequence value0)

addNamespace

protected void addNamespace(int parent,
                            int nscode)

getNode

public net.sf.saxon.tinytree.TinyNodeImpl getNode(int nr)

getUntypedAtomicValue

protected UntypedAtomicValue getUntypedAtomicValue(int nodeNr)
Get the typed value of a node. The node must be a document, element, text, comment, or processing-instruction node, and it must have no type annotation. This method gets the typed value of a numbered node without actually instantiating the NodeInfo object, as a performance optimization.


getSequenceNumber

public long getSequenceNumber()
Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive.

Overrides:
getSequenceNumber in class net.sf.saxon.tinytree.TinyNodeImpl

getAttributeNode

protected net.sf.saxon.tinytree.TinyAttributeImpl getAttributeNode(int nr)
Make a (transient) attribute node from the array of attributes


getAttributeAnnotation

protected int getAttributeAnnotation(int nr)
Get the type annotation of an attribute node.

Returns:
Type.UNTYPED_ATOMIC if there is no annotation

isUsingNamespaces

protected boolean isUsingNamespaces()
determine whether this document uses namespaces


getNamespaceNode

protected net.sf.saxon.tinytree.TinyNamespaceImpl getNamespaceNode(int nr)
Make a (transient) namespace node from the array of namespace declarations


setSystemId

public void setSystemId(java.lang.String uri)
Set the system id of this node

Specified by:
setSystemId in interface javax.xml.transform.Source
Overrides:
setSystemId in class net.sf.saxon.tinytree.TinyNodeImpl

getSystemId

public java.lang.String getSystemId()
Get the system id of this root node

Specified by:
getSystemId in interface NodeInfo
Overrides:
getSystemId in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
the System Identifier of the entity in the source document containing the node, or null if not known. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot.

getBaseURI

public java.lang.String getBaseURI()
Get the base URI of this root node. For a root node the base URI is the same as the System ID.

Specified by:
getBaseURI in interface NodeInfo
Overrides:
getBaseURI in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
the base URI of the node

setSystemId

protected void setSystemId(int seq,
                           java.lang.String uri)
Set the system id of an element in the document


getSystemId

protected java.lang.String getSystemId(int seq)
Get the system id of an element in the document


setLineNumbering

public void setLineNumbering()
Set line numbering on


setLineNumber

protected void setLineNumber(int sequence,
                             int line)
Set the line number for an element. Ignored if line numbering is off.


getLineNumber

protected int getLineNumber(int sequence)
Get the line number for an element. Return -1 if line numbering is off.


getLineNumber

public int getLineNumber()
Get the line number of this root node.

Specified by:
getLineNumber in interface NodeInfo
Overrides:
getLineNumber in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
0 always

getNodeKind

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

Specified by:
getNodeKind in interface NodeInfo
Returns:
Type.DOCUMENT (always)
See Also:
Type

getParent

public NodeInfo getParent()
Find the parent node of this node.

Specified by:
getParent in interface NodeInfo
Overrides:
getParent in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
The Node object describing the containing element or root node.

getRoot

public NodeInfo getRoot()
Get the root node

Specified by:
getRoot in interface NodeInfo
Overrides:
getRoot in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
the NodeInfo that is the root of the tree - not necessarily a document node

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root (document) node

Specified by:
getDocumentRoot in interface NodeInfo
Overrides:
getDocumentRoot in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
the DocumentInfo representing the document node, or null if the root of the tree is not a document node

generateId

public java.lang.String generateId()
Get a character string that uniquely identifies this node

Specified by:
generateId in interface NodeInfo
Overrides:
generateId in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
an identifier based on the document number

getAllElements

protected AxisIterator getAllElements(int fingerprint)
Get a list of all elements with a given name. This is implemented as a memo function: the first time it is called for a particular element type, it remembers the result for next time.


selectID

public NodeInfo selectID(java.lang.String id)
Get the element with a given ID.

Specified by:
selectID in interface DocumentInfo
Parameters:
id - The unique ID of the required element, previously registered using registerID()
Returns:
The NodeInfo (always an Element) for the given ID if one has been registered, otherwise null.

setUnparsedEntity

protected void setUnparsedEntity(java.lang.String name,
                                 java.lang.String uri,
                                 java.lang.String publicId)
Set an unparsed entity URI associated with this document. For system use only, while building the document.


getUnparsedEntity

public java.lang.String[] getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given nameID if there is one, or null if not. If the entity does not exist, return null.

Specified by:
getUnparsedEntity in interface DocumentInfo
Parameters:
name - the name of the entity
Returns:
if the entity exists, return an array of two Strings, the first holding the system ID of the entity, the second holding the public

copy

public void copy(Receiver out,
                 int whichNamespaces,
                 boolean copyAnnotations)
          throws javax.xml.transform.TransformerException
Copy this node to a given outputter

Specified by:
copy in interface NodeInfo
Parameters:
out - the Receiver to which the node should be copied
whichNamespaces - in the case of an element, controls which namespace nodes should be copied. Values are NO_NAMESPACES, LOCAL_NAMESPACES, ALL_NAMESPACES
copyAnnotations - indicates whether the type annotations of element and attribute nodes should be copied
Throws:
javax.xml.transform.TransformerException

diagnosticDump

public void diagnosticDump()
Produce diagnostic print of main tree arrays


showSize

public void showSize()

hasChildNodes

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

Specified by:
hasChildNodes in interface org.w3c.dom.Node
Overrides:
hasChildNodes in class net.sf.saxon.tinytree.TinyNodeImpl
Returns:
true if this node has any attributes, false otherwise.

getStringValue

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

Specified by:
getStringValue in interface NodeInfo
Specified by:
getStringValue in class AbstractNode
Returns:
the accumulated character content of the element, including descendant elements.

setParentNode

protected void setParentNode(net.sf.saxon.tinytree.TinyNodeImpl parent)
Set the parent of this node. Providing this information is useful, if it is known, because otherwise getParent() has to search backwards through the document.


isSameNode

public boolean isSameNode(NodeInfo other)
Determine whether this is the same node as another node

Specified by:
isSameNode in interface NodeInfo
Specified by:
isSameNode in class AbstractNode
Returns:
true if this Node object and the supplied Node object represent the same node in the tree.

getOriginatingNode

public org.w3c.dom.Node getOriginatingNode()
Get the node corresponding to this javax.xml.transform.dom.DOMLocator

Specified by:
getOriginatingNode in interface javax.xml.transform.dom.DOMLocator
Overrides:
getOriginatingNode in class AbstractNode

compareOrder

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
Specified by:
compareOrder in class 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())

getFingerprint

public int getFingerprint()
Get the fingerprint of the node, used for matching names

Specified by:
getFingerprint in interface NodeInfo
Specified by:
getFingerprint in class AbstractNode
Returns:
an integer fingerprint; two nodes with the same fingerprint have the same expanded QName

getNameCode

public int getNameCode()
Get the name code of the node, used for matching names

Specified by:
getNameCode in interface NodeInfo
Specified by:
getNameCode in class AbstractNode
Returns:
an integer name code, which may be used to obtain the actual node name from the name pool
See Also:
allocate, getFingerprint

getPrefix

public java.lang.String getPrefix()
Get the prefix part of the name of this node. This is the name before the ":" if any.

Returns:
the prefix part of the name. For an unnamed node, return "".

getURI

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

Specified by:
getURI in interface NodeInfo
Specified by:
getURI in class AbstractNode
Returns:
The URI of the namespace of this node. For an unnamed node, or for an element or attribute in the default namespace, return an empty string.

getDisplayName

public java.lang.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 class AbstractNode
Returns:
The display name of this node. For a node with no name, return an empty string.

getLocalPart

public java.lang.String getLocalPart()
Get the local name of this node.

Specified by:
getLocalPart in interface NodeInfo
Specified by:
getLocalPart in class AbstractNode
Returns:
The local name of this node. For a node with no name, return "".

iterateAxis

public AxisIterator iterateAxis(byte axisNumber)
Return an iterator over all the nodes reached by the given axis from this node

Parameters:
axisNumber - Identifies the required axis, eg. Axis.CHILD or Axis.PARENT
Returns:
a AxisIteratorImpl that scans the nodes reached by the axis in turn.
See Also:
Axis

iterateAxis

public AxisIterator iterateAxis(byte axisNumber,
                                NodeTest nodeTest)
Return an iterator over the nodes reached by the given axis from this node

Specified by:
iterateAxis in interface NodeInfo
Specified by:
iterateAxis in class AbstractNode
Parameters:
axisNumber - Identifies the required axis, eg. Axis.CHILD or Axis.PARENT
nodeTest - A pattern to be matched by the returned nodes.
Returns:
a AxisIteratorImpl that scans the nodes reached by the axis in turn.

hasAttributes

public boolean hasAttributes()
Returns whether this node has any attributes.

Specified by:
hasAttributes in interface org.w3c.dom.Node
Specified by:
hasAttributes in class AbstractNode
Returns:
true if this node has any attributes, false otherwise.
Since:
DOM Level 2

getAttributeValue

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

Specified by:
getAttributeValue in interface NodeInfo
Specified by:
getAttributeValue in class AbstractNode
Parameters:
fingerprint - The fingerprint of the attribute name
Returns:
the attribute value if it exists or null if not

outputNamespaceNodes

public void outputNamespaceNodes(Receiver out,
                                 boolean includeAncestors)
                          throws javax.xml.transform.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 class AbstractNode
Parameters:
out - The relevant outputter
includeAncestors - True if namespaces declared on ancestor elements must be output; false if it is known that these are already on the result tree
javax.xml.transform.TransformerException