java.lang.Object
- com.icl.saxon.om.AbstractNode
- - com.icl.saxon.tree.NodeImpl
  - - com.icl.saxon.tree.ElementImpl

All Implemented Interfaces:

NodeInfo, DOMLocator, Source, SourceLocator, Element, Node

Direct Known Subclasses:

ElementWithAttributes
```
public class ElementImpl
extends NodeImpl
implements Element
```
ElementImpl implements an element with no attributes or namespace declarations.
This class is an implementation of NodeInfo. For elements with attributes or namespace declarations, class ElementWithAttributes is used.

Field Summary

Fields
Modifier and Type Field Description

protected int nameCode

protected DocumentImpl root

protected int sequence
- Fields inherited from class com.icl.saxon.tree.NodeImpl
  emptyArray, index, parent
- Fields inherited from class com.icl.saxon.om.AbstractNode
  NODE_LETTER
- Fields inherited from interface org.w3c.dom.Node
  ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
- Fields inherited from interface com.icl.saxon.om.NodeInfo
  ATTRIBUTE, COMMENT, ELEMENT, NAMESPACE, NODE, NONE, NUMBER_OF_TYPES, PI, ROOT, TEXT

Constructor Summary

Constructors
Constructor Description

ElementImpl()
Construct an empty ElementImpl

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addChild(NodeImpl node, int index)`	Add a child node to this node.
`void`	`addNamespaceNodes(ElementImpl owner, Vector list, boolean addXML)`	Make the set of all namespace nodes associated with this element.
`void`	`compact(int size)`	Compact the space used by this node
`void`	`copy(Outputter out)`	Copy this node to a given outputter (supporting xsl:copy-of)
`void`	`copy(Outputter out, boolean allNamespaces)`	Copy this node to a given outputter (supporting xsl:copy-of)
`void`	`copyStringValue(Outputter out)`	Copy the string-value of this node to a given outputter
`void`	`dropChildren()`	Drop a branch of the tree.
`AxisEnumeration`	`enumerateChildren(NodeTest test)`	Get an enumeration of the children of this node
`String`	`generateId()`	Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)
`AttributeCollection`	`getAttributeList()`	Get the attribute list for this element.
`String`	`getAttributeValue(String name)`	Find the value of a given attribute of this element.
`String`	`getBaseURI()`	Get the base URI of this element node.
`NodeList`	`getChildNodes()`	Return a `NodeList` that contains all children of this node.
`DocumentInfo`	`getDocumentRoot()`	Get the root node
`Node`	`getFirstChild()`	Get the first child node of the element
`Node`	`getLastChild()`	Get the last child node of the element
`int`	`getLineNumber()`	Get the line number of the node within its source document entity
`int`	`getNameCode()`	Get the nameCode of the node.
`short`	`getNodeType()`	Return the type of node.
`String`	`getNodeValue()`	Get the node value as defined in the DOM.
`protected NodeImpl`	`getNthChild(int n)`	Get the nth child node of the element (numbering from 0)
`String`	`getPrefixForURI(String uri)`	Search the NamespaceList for a given URI, returning the corresponding prefix.
`protected long`	`getSequenceNumber()`	Get the node sequence number (in document order).
`String`	`getStringValue()`	Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
`String`	`getSystemId()`	Get the system ID of the entity containing this element node.
`short`	`getURICodeForPrefix(String prefix)`	Search the NamespaceList for a given prefix, returning the corresponding URI.
`boolean`	`hasChildNodes()`	Determine if the node has any children.
`void`	`initialise(int nameCode, AttributeCollection atts, NodeInfo parent, String baseURI, int lineNumber, int sequenceNumber)`	Initialise a new ElementImpl with an element name
`int`	`makeNameCode(String qname, boolean useDefault)`	Make a NameCode, using this Element as the context for namespace resolution.
`void`	`outputNamespaceNodes(Outputter out, boolean includeAncestors)`	Output all namespace nodes associated with this element.
`void`	`removeChild(int index)`	Remove node at given index.
`void`	`renumberChildren()`	Renumber the children of a given parent node.
`void`	`setAttribute(String name, String value)`	Set the value of an attribute on the current element.
`void`	`setLineNumber(int line)`	Set the line number of the element within its source document entity
`void`	`setNameCode(int nameCode)`	Set the name code.
`void`	`setSystemId(String uri)`	Set the system ID of this node.
`void`	`useChildrenArray(NodeImpl[] array)`	Supply an array to be used for the array of children.

Methods inherited from class com.icl.saxon.tree.NodeImpl
compareOrder, getAttributes, getAttributeValue, getAttributeValue, getDisplayName, getDocumentElement, getEnumeration, getFingerprint, getLocalName, getNamePool, getNextInDocument, getNextSibling, getOriginatingNode, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getURI, hasAttributes, isSameNodeInfo, removeNode

Methods inherited from class com.icl.saxon.om.AbstractNode
appendChild, appendData, cloneNode, compareDocumentPosition, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getColumnNumber, getData, getDoctype, getElementById, getElementsByTagName, getElementsByTagNameNS, getFeature, getImplementation, getLength, getName, getNamespaceURI, getNodeName, getOwnerDocument, getOwnerElement, getParentNode, getPublicId, getSchemaTypeInfo, getSpecified, getTagName, getTextContent, getUserData, getValue, getWholeText, hasAttribute, hasAttributeNS, importNode, insertBefore, insertData, isDefaultNamespace, isElementContentWhitespace, isEqualNode, isId, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, replaceChild, replaceData, replaceWholeText, setAttributeNode, setAttributeNodeNS, setAttributeNS, setData, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setPrefix, setTextContent, setUserData, 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 org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from interface javax.xml.transform.Source
isEmpty

- Field Detail
  - nameCode
```
protected int nameCode
```
  - root
```
protected DocumentImpl root
```
  - sequence
```
protected int sequence
```
- Constructor Detail
  - ElementImpl
```
public ElementImpl()
```
    Construct an empty ElementImpl
- Method Detail
  - setNameCode
```
public void setNameCode(int nameCode)
```
    Set the name code. Used when creating a dummy element in the Stripper
  - initialise
```
public void initialise(int nameCode,
                       AttributeCollection atts,
                       NodeInfo parent,
                       String baseURI,
                       int lineNumber,
                       int sequenceNumber)
```
    Initialise a new ElementImpl with an element name
    
    Parameters:
    
    name - The element name, with namespaces resolved
    
    atts - The attribute list: always null
    
    parent - The parent node
  - setSystemId
```
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
    
    Specified by:
    
    setSystemId in interface Source
    
    Overrides:
    
    setSystemId in class NodeImpl
  - getDocumentRoot
```
public DocumentInfo getDocumentRoot()
```
    Get the root node
    
    Specified by:
    
    getDocumentRoot in interface NodeInfo
    
    Overrides:
    
    getDocumentRoot in class NodeImpl
    
    Returns:
    
    the DocumentInfo representing the containing document
  - getSystemId
```
public final String getSystemId()
```
    Get the system ID of the entity containing this element node.
    
    Specified by:
    
    getSystemId in interface NodeInfo
    
    Specified by:
    
    getSystemId in interface Source
    
    Specified by:
    
    getSystemId in interface SourceLocator
    
    Overrides:
    
    getSystemId in class NodeImpl
    
    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 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 Node
    
    Specified by:
    
    getBaseURI in interface NodeInfo
    
    Overrides:
    
    getBaseURI in class NodeImpl
  - setLineNumber
```
public void setLineNumber(int line)
```
    Set the line number of the element within its source document entity
  - getLineNumber
```
public int getLineNumber()
```
    Get the line number of the node within its source document entity
    
    Specified by:
    
    getLineNumber in interface NodeInfo
    
    Specified by:
    
    getLineNumber in interface SourceLocator
    
    Overrides:
    
    getLineNumber in class NodeImpl
    
    Returns:
    
    the line number of the node in its original source document; or -1 if not available
  - getNameCode
```
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 class NodeImpl
    
    See Also:
    
    allocate, getFingerprint
  - 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 class NodeImpl
    
    Returns:
    
    a string.
  - getURICodeForPrefix
```
public short getURICodeForPrefix(String prefix)
                          throws NamespaceException
```
    Search the NamespaceList for a given prefix, returning the corresponding URI.
    
    Parameters:
    
    prefix - The prefix to be matched. To find the default namespace, supply ""
    
    Returns:
    
    The URI code corresponding to this namespace. If it is an unnamed default namespace, return Namespace.NULL_CODE.
    
    Throws:
    
    NamespaceException - if the prefix has not been declared on this NamespaceList.
  - getPrefixForURI
```
public String getPrefixForURI(String uri)
```
    Search the NamespaceList for a given URI, returning the corresponding prefix.
    
    Parameters:
    
    uri - The URI to be matched.
    
    Returns:
    
    The prefix corresponding to this URI. If not found, return null. If there is more than one prefix matching the URI, the first one found is returned. If the URI matches the default namespace, return an empty string.
  - makeNameCode
```
public final int makeNameCode(String qname,
                              boolean useDefault)
                       throws NamespaceException
```
    Make a NameCode, using this Element as the context for namespace resolution. The name will be entered in the namepool: therefore this method should not be called once the name pool is sealed.
    
    Parameters:
    
    qname - The name as written, in the form "[prefix:]localname"
    
    Throws:
    
    NamespaceException
  - addNamespaceNodes
```
public void addNamespaceNodes(ElementImpl owner,
                              Vector list,
                              boolean addXML)
```
    Make the set of all namespace nodes associated with this element.
    
    Parameters:
    
    owner - The element owning these namespace nodes.
    
    list - a Vector containing NamespaceImpl objects representing the namespaces in scope for this element; the method appends nodes to this Vector, which should initially be empty. Note that the returned list will never contain the XML namespace (to get this, the NamespaceEnumeration class adds it itself). The list WILL include an entry for the undeclaration xmlns=""; again it is the job of NamespaceEnumeration to ignore this, since it doesn't represent a true namespace node.
    
    addXML - Add the XML namespace node to the list
  - outputNamespaceNodes
```
public void outputNamespaceNodes(Outputter out,
                                 boolean includeAncestors)
                          throws TransformerException
```
    Output all namespace nodes associated with this element.
    
    Specified by:
    
    outputNamespaceNodes in interface NodeInfo
    
    Overrides:
    
    outputNamespaceNodes in class NodeImpl
    
    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
    
    Throws:
    
    TransformerException
  - getNodeType
```
public final short getNodeType()
```
    Return the type of node.
    
    Specified by:
    
    getNodeType in interface Node
    
    Specified by:
    
    getNodeType in interface NodeInfo
    
    Returns:
    
    NodeInfo.ELEMENT
  - getAttributeList
```
public AttributeCollection getAttributeList()
```
    Get the attribute list for this element.
    
    Returns:
    
    The attribute list. This will not include any namespace attributes. The attribute names will be in expanded form, with prefixes replaced by URIs
  - getAttributeValue
```
public String getAttributeValue(String name)
```
    Find the value of a given attribute of this element.
    This is a short-cut method; the full capability to examine attributes is offered via the getAttributeList() method.
    The attribute may either be one that was present in the original XML document, or one that has been set by the application using setAttribute().
    
    Parameters:
    
    name - the name of an attribute. There must be no prefix in the name.
    
    Returns:
    
    the value of the attribute, if it exists, otherwise null
  - setAttribute
```
public void setAttribute(String name,
                         String value)
                  throws DOMException
```
    Set the value of an attribute on the current element.
    
    Specified by:
    
    setAttribute in interface Element
    
    Throws:
    
    DOMException - (always): the Saxon tree is immutable
  - copy
```
public void copy(Outputter out)
          throws TransformerException
```
    Copy this node to a given outputter (supporting xsl:copy-of)
    
    Specified by:
    
    copy in interface NodeInfo
    
    Throws:
    
    TransformerException
  - copy
```
public void copy(Outputter out,
                 boolean allNamespaces)
          throws TransformerException
```
    Copy this node to a given outputter (supporting xsl:copy-of)
    
    Parameters:
    
    out - The outputter
    
    allNamespaces - true if namespaces for ancestor nodes must be output
    
    Throws:
    
    TransformerException
  - getSequenceNumber
```
protected final 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.
    
    Overrides:
    
    getSequenceNumber in class NodeImpl
  - hasChildNodes
```
public final boolean hasChildNodes()
```
    Determine if the node has any children.
    
    Specified by:
    
    hasChildNodes in interface Node
    
    Specified by:
    
    hasChildNodes in interface NodeInfo
    
    Overrides:
    
    hasChildNodes in class NodeImpl
    
    Returns:
    
    true if the node has any children, false if the node has no children.
  - enumerateChildren
```
public final AxisEnumeration enumerateChildren(NodeTest test)
```
    Get an enumeration of the children of this node
  - getFirstChild
```
public final Node getFirstChild()
```
    Get the first child node of the element
    
    Specified by:
    
    getFirstChild in interface Node
    
    Overrides:
    
    getFirstChild in class NodeImpl
    
    Returns:
    
    the first child node of the required type, or null if there are no children
  - getLastChild
```
public final Node getLastChild()
```
    Get the last child node of the element
    
    Specified by:
    
    getLastChild in interface Node
    
    Overrides:
    
    getLastChild in class NodeImpl
    
    Returns:
    
    the last child of the element, or null if there are no children
  - getChildNodes
```
public final NodeList getChildNodes()
```
    Return a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
    
    Specified by:
    
    getChildNodes in interface Node
    
    Overrides:
    
    getChildNodes in class NodeImpl
  - getNthChild
```
protected final NodeImpl getNthChild(int n)
```
    Get the nth child node of the element (numbering from 0)
    
    Returns:
    
    the last child of the element, or null if there is no n'th child
  - getStringValue
```
public 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.
  - copyStringValue
```
public void copyStringValue(Outputter out)
                     throws TransformerException
```
    Copy the string-value of this node to a given outputter
    
    Specified by:
    
    copyStringValue in interface NodeInfo
    
    Overrides:
    
    copyStringValue in class AbstractNode
    
    Throws:
    
    TransformerException
  - useChildrenArray
```
public void useChildrenArray(NodeImpl[] array)
```
    Supply an array to be used for the array of children. For system use only.
  - addChild
```
public void addChild(NodeImpl node,
                     int index)
```
    Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.
  - removeChild
```
public void removeChild(int index)
```
    Remove node at given index. Will always be followed by a renumberChildren().
  - renumberChildren
```
public void renumberChildren()
```
    Renumber the children of a given parent node. For system use only
  - dropChildren
```
public void dropChildren()
```
    Drop a branch of the tree. The target element remains in the tree, but its children are disconnected from the parent. Unless there are other references to the children (e.g. in a variable) they will be deleted from memory next time the garbage collector comes round.
  - compact
```
public void compact(int size)
```
    Compact the space used by this node
  - getNodeValue
```
public String getNodeValue()
```
    Get the node value as defined in the DOM. This is not the same as the XPath string-value.
    
    Specified by:
    
    getNodeValue in interface Node
    
    Overrides:
    
    getNodeValue in class AbstractNode

Modifier and Type	Field	Description
`protected int`	`nameCode`
`protected DocumentImpl`	`root`
`protected int`	`sequence`

Class ElementImpl

Field Summary

Fields inherited from class com.icl.saxon.tree.NodeImpl

Fields inherited from class com.icl.saxon.om.AbstractNode

Fields inherited from interface org.w3c.dom.Node

Fields inherited from interface com.icl.saxon.om.NodeInfo

Constructor Summary

Method Summary

Methods inherited from class com.icl.saxon.tree.NodeImpl

Methods inherited from class com.icl.saxon.om.AbstractNode

Methods inherited from class java.lang.Object

Methods inherited from interface org.w3c.dom.Element

Methods inherited from interface org.w3c.dom.Node

Methods inherited from interface javax.xml.transform.Source

Field Detail

nameCode

root

sequence

Constructor Detail

ElementImpl

Method Detail

setNameCode

initialise

setSystemId

getDocumentRoot

getSystemId

getBaseURI

setLineNumber

getLineNumber

getNameCode

generateId

getURICodeForPrefix

getPrefixForURI

makeNameCode

addNamespaceNodes

outputNamespaceNodes

getNodeType

getAttributeList

getAttributeValue

setAttribute

copy

copy

getSequenceNumber

hasChildNodes

enumerateChildren

getFirstChild

getLastChild

getChildNodes

getNthChild

getStringValue

copyStringValue

useChildrenArray

addChild

removeChild

renumberChildren

dropChildren

compact

getNodeValue