net.sf.saxon.tree

Class AttributeImpl

final class AttributeImpl extends NodeImpl

A node in the "linked" tree representing an attribute. Note that this is generated only "on demand", when the attribute is selected by a path expression.

It is possible for multiple AttributeImpl objects to represent the same attribute node. The identity of an attribute node is determined by the identity of the element, and the index position of the attribute within the element. Index positions are not reused when an attribute is deleted, and are retained when an attribute is renamed.

This object no longer caches information such as the name code and string value, because these would become invalid when the element node is modified.

Author: Michael H. Kay

Constructor Summary
AttributeImpl(ElementImpl element, int index)
Construct an Attribute node for the n'th attribute of a given element
Method Summary
voidcopy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter
voiddelete()
Delete this node (that is, detach it from its parent)
voidgenerateId(FastStringBuffer buffer)
Get sequential key.
intgetNameCode()
Get the name code, which enables the name to be located in the name pool
NodeImplgetNextInDocument(NodeImpl anchor)
Get the next node in document order (skipping attributes)
NodeInfogetNextSibling()
Get next sibling - not defined for attributes
intgetNodeKind()
Return the type of node.
NodeImplgetPreviousInDocument()
Get the previous node in document order (skipping attributes)
NodeInfogetPreviousSibling()
Get previous sibling - not defined for attributes
protected longgetSequenceNumber()
Get the node sequence number (in document order).
StringgetStringValue()
Return the character value of the node.
intgetTypeAnnotation()
Get the type annotation of this node, if any
inthashCode()
The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal (represent the same node) then they must have the same hashCode()
booleanisDeleted()
Test whether this MutableNodeInfo object represents a node that has been deleted.
booleanisId()
Determine whether this node has the is-id property
booleanisIdref()
Determine whether this node has the is-idref property
booleanisNilled()
Determine whether the node has the is-nilled property
booleanisSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
voidremoveTypeAnnotation()
Remove type information from this node (and its ancestors, recursively).
voidrename(int newNameCode)
Rename this node
voidreplace(NodeInfo[] replacement, boolean inherit)
Replace this node with a given sequence of nodes
voidreplaceStringValue(CharSequence stringValue)
voidsetTypeAnnotation(int typeCode)
Set the type annotation on a node.

Constructor Detail

AttributeImpl

public AttributeImpl(ElementImpl element, int index)
Construct an Attribute node for the n'th attribute of a given element

Parameters: element The element containing the relevant attribute index The index position of the attribute starting at zero

Method Detail

copy

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

delete

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

generateId

public void generateId(FastStringBuffer buffer)
Get sequential key. Returns key of owning element with the attribute index as a suffix

Parameters: buffer a buffer to which the generated ID will be written

getNameCode

public int getNameCode()
Get the name code, which enables the name to be located in the name pool

getNextInDocument

public NodeImpl getNextInDocument(NodeImpl anchor)
Get the next node in document order (skipping attributes)

getNextSibling

public NodeInfo getNextSibling()
Get next sibling - not defined for attributes

getNodeKind

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

Returns: Node.ATTRIBUTE

getPreviousInDocument

public NodeImpl getPreviousInDocument()
Get the previous node in document order (skipping attributes)

getPreviousSibling

public NodeInfo getPreviousSibling()
Get previous sibling - not defined for attributes

getSequenceNumber

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

getStringValue

public String getStringValue()
Return the character value of the node.

Returns: the attribute value

getTypeAnnotation

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

hashCode

public int hashCode()
The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal (represent the same node) then they must have the same hashCode()

Since: 8.7 Previously, the effect of the equals() and hashCode() methods was not defined. Callers should therefore be aware that third party implementations of the NodeInfo interface may not implement the correct semantics.

isDeleted

public boolean isDeleted()
Test whether this MutableNodeInfo object represents a node that has been deleted. Generally, such a node is unusable, and any attempt to use it will result in an exception being thrown

Returns: true if this node has been deleted

isId

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

Returns: true if the node is an ID

isIdref

public boolean isIdref()
Determine whether this node has the is-idref property

Returns: true if the node is an IDREF or IDREFS element or attribute

isNilled

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

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

isSameNodeInfo

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

Returns: true if this Node object and the supplied Node object represent the same node in the tree.

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

replace

public void replace(NodeInfo[] replacement, boolean inherit)
Replace this node with a given sequence of nodes

Parameters: replacement the replacement nodes (which for this version of the method must be attribute nodes). The target attribute node is deleted, and the replacement nodes are added to the parent element; if they have the same names as existing nodes, then the existing nodes will be overwritten. inherit set to true if new child elements are to inherit the in-scope namespaces of their new parent. Not used when replacing attribute nodes.

Throws: IllegalArgumentException if any of the replacement nodes is not an attribute IllegalStateException if two of the replacement nodes have the same name

replaceStringValue

public void replaceStringValue(CharSequence stringValue)

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)