com.icl.saxon.tree
Class ElementImpl

java.lang.Object
  extended by com.icl.saxon.om.AbstractNode
      extended by com.icl.saxon.tree.NodeImpl
          extended by com.icl.saxon.tree.ParentNodeImpl
              extended by com.icl.saxon.tree.ElementImpl
All Implemented Interfaces:
NodeInfo, DOMLocator, Source, SourceLocator, Element, Node
Direct Known Subclasses:
ElementWithAttributes

public class ElementImpl
extends ParentNodeImpl
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.

Author:
Michael H. Kay

Field Summary
protected  int nameCode
           
protected  DocumentImpl root
           
 
Fields inherited from class com.icl.saxon.tree.ParentNodeImpl
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
ElementImpl()
          Construct an empty ElementImpl
 
Method Summary
 void addNamespaceNodes(ElementImpl owner, Vector list, boolean addXML)
          Make the set of all namespace nodes associated with this element.
 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)
 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.
 DocumentInfo getDocumentRoot()
          Get the root node
 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 getPrefixForURI(String uri)
          Search the NamespaceList for a given URI, returning the corresponding prefix.
 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.
 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 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.
 
Methods inherited from class com.icl.saxon.tree.ParentNodeImpl
addChild, compact, copyStringValue, dropChildren, enumerateChildren, getChildNodes, getFirstChild, getLastChild, getNodeValue, getNthChild, getSequenceNumber, getStringValue, hasChildNodes, removeChild, renumberChildren, useChildrenArray
 
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
 

Field Detail

nameCode

protected int nameCode

root

protected DocumentImpl root
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 NodeInfo
Specified by:
getBaseURI in interface Node
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 NodeInfo
Specified by:
getNodeType in interface Node
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