net.sf.saxon.tree

Class ElementImpl

public class ElementImpl extends ParentNodeImpl implements NamespaceResolver

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 AttributeCollectionattributeList
protected intnameCode
protected int[]namespaceList
protected inttypeCode
Constructor Summary
ElementImpl()
Construct an empty ElementImpl
Method Summary
voidaddAttribute(int nameCode, int typeCode, CharSequence value, int properties)
Add an attribute to this element node.
voidaddNamespace(int nscode, boolean inherit)
Add a namespace binding (that is, a namespace node) to this element.
voidcopy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter (supporting xsl:copy-of)
voiddelete()
Delete this node (that is, detach it from its parent)
protected voidfixupInsertedNamespaces(boolean inherit)
Ensure that a child element being inserted into a tree has the right namespace declarations.
voidgenerateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node
AttributeCollectiongetAttributeList()
Get the attribute list for this element.
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
StringgetAttributeValue(String uri, String localName)
Get the value of a given attribute of this node
StringgetBaseURI()
Get the base URI of this element node.
intgetColumnNumber()
Get the line number of the node within its source document entity
int[]getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
DocumentInfogetDocumentRoot()
Get the root node, if it is a document node.
int[]getInScopeNamespaceCodes()
Get the list of in-scope namespaces for this element as an array of namespace codes.
intgetLineNumber()
Get the line number of the node within its source document entity
intgetNameCode()
Get the nameCode of the node.
intgetNodeKind()
Return the kind of node.
StringgetPrefixForURI(String uri)
Search the NamespaceList for a given URI, returning the corresponding prefix.
NodeInfogetRoot()
Get the root node
StringgetSystemId()
Get the system ID of the entity containing this element node.
intgetTypeAnnotation()
Get the type annotation of this node, if any
shortgetURICodeForPrefix(String prefix)
Search the NamespaceList for a given prefix, returning the corresponding URI.
protected shortgetURICodeForPrefixCode(int prefixCode)
Get the URI bound to a given prefix in the in-scope namespaces of this element
StringgetURIForPrefix(String prefix, boolean useDefault)
Get the namespace URI corresponding to a given prefix.
voidinitialise(int nameCode, int typeCode, AttributeCollectionImpl atts, NodeInfo parent, int sequenceNumber)
Initialise a new ElementImpl with an element name
booleanisId()
Determine whether this node has the is-id property
booleanisNilled()
Determine whether the node has the is-nilled property
IteratoriteratePrefixes()
Get an iterator over all the prefixes declared in this namespace context.
voidremoveAttribute(NodeInfo attribute)
Remove an attribute from this element node

If this node is not an element, or if the specified node is not an attribute of this element, this method takes no action.

The attribute object itself becomes unusable; any attempt to use this attribute object, or any other object representing the same node, is likely to result in an exception.

voidremoveTypeAnnotation()
Remove type information from this node (and its ancestors, recursively).
voidrename(int newNameCode)
Rename this node
voidreplaceStringValue(CharSequence stringValue)
Replace the string-value of this node
voidsetLineAndColumn(int line, int column)
Set the line number of the element within its source document entity
voidsetLocation(String systemId, int line, int column)
Set location information for this node
voidsetNameCode(int nameCode)
Set the name code.
voidsetNamespaceDeclarations(int[] namespaces, int namespacesUsed)
Set the namespace declarations for the element
voidsetSystemId(String uri)
Set the system ID of this node.
voidsetTypeAnnotation(int typeCode)
Set the type annotation on a node.

Field Detail

attributeList

protected AttributeCollection attributeList

nameCode

protected int nameCode

namespaceList

protected int[] namespaceList

typeCode

protected int typeCode

Constructor Detail

ElementImpl

public ElementImpl()
Construct an empty ElementImpl

Method Detail

addAttribute

public void addAttribute(int nameCode, int typeCode, CharSequence value, int properties)
Add an attribute to this element node.

If this node is not an element, or if the supplied node is not an attribute, the method takes no action. If the element already has an attribute with this name, the method throws an exception.

This method does not perform any namespace fixup. It is the caller's responsibility to ensure that any namespace prefix used in the name of the attribute (or in its value if it has a namespace-sensitive type) is declared on this element.

Parameters: nameCode the name of the new attribute typeCode the type annotation of the new attribute value the string value of the new attribute properties properties including IS_ID and IS_IDREF properties

Throws: IllegalStateException if the element already has an attribute with the given name.

addNamespace

public void addNamespace(int nscode, boolean inherit)
Add a namespace binding (that is, a namespace node) to this element. This call has no effect if applied to a node other than an element.

Parameters: nscode The namespace code representing the (prefix, uri) pair of the namespace binding to be added. If the target element already has a namespace binding with this (prefix, uri) pair, the call has no effect. If the target element currently has a namespace binding with this prefix and a different URI, an exception is raised. inherit If true, the new namespace binding will be inherited by any children of the target element that do not already have a namespace binding for the specified prefix, recursively. If false, the new namespace binding will not be inherited.

Throws: IllegalArgumentException if the target element already has a namespace binding for this prefix, or if the namespace code represents a namespace undeclaration

copy

public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter (supporting xsl:copy-of)

Parameters: out The outputter whichNamespaces indicates which namespaces should be output: all, none, or local namespaces only (those not declared on the parent element)

delete

public void delete()
Delete this node (that is, detach it from its parent)

fixupInsertedNamespaces

protected void fixupInsertedNamespaces(boolean inherit)
Ensure that a child element being inserted into a tree has the right namespace declarations. Redundant declarations should be removed. If the child is in the null namespace but the parent has a default namespace, xmlns="" should be added. If inherit is false, namespace undeclarations should be added for all namespaces that are declared on the parent but not on the child.

Parameters: inherit true if the child is to inherit the inscope namespaces of its new parent

generateId

public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node

Parameters: buffer to contain the generated ID

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(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

getAttributeValue

public String getAttributeValue(String uri, String localName)
Get the value of a given attribute of this node

Parameters: uri the namespace URI of the attribute name, or "" if the attribute is not in a namepsace localName the local part 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.

getColumnNumber

public int getColumnNumber()
Get the line number of the node within its source document entity

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.

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root node, if it is a document node.

Returns: the DocumentInfo representing the containing document. If this node is part of a tree that does not have a document node as its root, returns null.

Since: 8.4

getInScopeNamespaceCodes

public int[] getInScopeNamespaceCodes()
Get the list of in-scope namespaces for this element as an array of namespace codes. (Used by LiteralResultElement)

Returns: the list of namespaces

getLineNumber

public int getLineNumber()
Get the line number of the node within its source document entity

getNameCode

public int getNameCode()
Get the nameCode of the node. This is used to locate the name in the NamePool

getNodeKind

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

Returns: Type.ELEMENT

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.

getRoot

public NodeInfo getRoot()
Get the root node

getSystemId

public final String getSystemId()
Get the system ID of the entity containing this element node.

getTypeAnnotation

public int getTypeAnnotation()
Get the type annotation of this node, if any

Returns: the type annotation, as the integer name code of the type name

getURICodeForPrefix

public short getURICodeForPrefix(String prefix)
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: net.sf.saxon.om.NamespaceException if the prefix has not been declared on this NamespaceList.

getURICodeForPrefixCode

protected short getURICodeForPrefixCode(int prefixCode)
Get the URI bound to a given prefix in the in-scope namespaces of this element

Parameters: prefixCode the prefix code as a 16-bit integer

Returns: the uri code as a 16-bit integer, or -1 if there is no in-scope binding for this prefix

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

initialise

public void initialise(int nameCode, int typeCode, AttributeCollectionImpl atts, NodeInfo parent, int sequenceNumber)
Initialise a new ElementImpl with an element name

Parameters: nameCode Integer representing the element name, with namespaces resolved typeCode Integer representing the schema type of the element node atts The attribute list: always null parent The parent node sequenceNumber Integer identifying this element within the document

isId

public boolean isId()
Determine whether this node has the is-id property

Returns: true if the node is an ID

isNilled

public boolean isNilled()
Determine whether the node has the is-nilled property

Returns: true if the node has the is-nilled property

iteratePrefixes

public Iterator iteratePrefixes()
Get an iterator over all the prefixes declared in this namespace context. This will include the default namespace (prefix="") and the XML namespace where appropriate

removeAttribute

public void removeAttribute(NodeInfo attribute)
Remove an attribute from this element node

If this node is not an element, or if the specified node is not an attribute of this element, this method takes no action.

The attribute object itself becomes unusable; any attempt to use this attribute object, or any other object representing the same node, is likely to result in an exception.

Parameters: attribute the attribute node to be removed

removeTypeAnnotation

public void removeTypeAnnotation()
Remove type information from this node (and its ancestors, recursively). This method implements the upd:removeType() primitive defined in the XQuery Update specification

rename

public void rename(int newNameCode)
Rename this node

Parameters: newNameCode the NamePool code of the new name

replaceStringValue

public void replaceStringValue(CharSequence stringValue)
Replace the string-value of this node

Parameters: stringValue the new string value

setLineAndColumn

public void setLineAndColumn(int line, int column)
Set the line number of the element within its source document entity

Parameters: line the line number column the column number

setLocation

public void setLocation(String systemId, int line, int column)
Set location information for this node

Parameters: systemId the base URI line the line number if known column the column number if known

setNameCode

public void setNameCode(int nameCode)
Set the name code. Used when creating a dummy element in the Stripper

Parameters: nameCode the integer name code representing the element name

setNamespaceDeclarations

public void setNamespaceDeclarations(int[] namespaces, int namespacesUsed)
Set the namespace declarations for the element

Parameters: namespaces the list of namespace codes namespacesUsed the number of entries in the list that are used

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

setTypeAnnotation

public void setTypeAnnotation(int typeCode)
Set the type annotation on a node. This must only be called when the caller has verified (by validation) that the node is a valid instance of the specified type. The call is ignored if the node is not an element or attribute node.

Parameters: typeCode the type annotation (possibly including high bits set to indicate the isID, isIDREF, and isNilled properties)