Package net.sf.saxon.tree.linked
Class AttributeImpl
- java.lang.Object
-
- net.sf.saxon.tree.linked.NodeImpl
-
- net.sf.saxon.tree.linked.AttributeImpl
-
- All Implemented Interfaces:
javax.xml.transform.Source
,javax.xml.transform.SourceLocator
,PullEvent
,FingerprintedNode
,Item<NodeInfo>
,MutableNodeInfo
,NodeInfo
,ValueRepresentation<NodeInfo>
,SiblingCountingNode
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
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.tree.linked.NodeImpl
NODE_LETTER
-
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
-
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
-
Constructor Summary
Constructors Constructor Description AttributeImpl(ElementImpl element, int index)
Construct an Attribute node for the n'th attribute of a given element
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
copy(Receiver out, int copyOptions, int locationId)
Copy this node to a given outputtervoid
delete()
Delete this node (that is, detach it from its parent)void
generateId(FastStringBuffer buffer)
Get sequential key.int
getNameCode()
Get the name code, which enables the name to be located in the name poolNodeImpl
getNextInDocument(NodeImpl anchor)
Get the next node in document order (skipping attributes)NodeInfo
getNextSibling()
Get next sibling - not defined for attributesint
getNodeKind()
Return the type of node.NodeImpl
getPreviousInDocument()
Get the previous node in document order (skipping attributes)NodeInfo
getPreviousSibling()
Get previous sibling - not defined for attributesSchemaType
getSchemaType()
Get the type annotationprotected long
getSequenceNumber()
Get the node sequence number (in document order).java.lang.String
getStringValue()
Return the character value of the node.int
getTypeAnnotation()
Get the fingerprint of the type annotation of this node, if anyint
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()boolean
isDeleted()
Test whether this MutableNodeInfo object represents a node that has been deleted.boolean
isId()
Determine whether this node has the is-id propertyboolean
isIdref()
Determine whether this node has the is-idref propertyboolean
isNilled()
Determine whether the node has the is-nilled propertyboolean
isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another nodevoid
removeTypeAnnotation()
Remove type information from this node (and its ancestors, recursively).void
rename(NodeName newNameCode)
Rename this nodevoid
replace(NodeInfo[] replacement, boolean inherit)
Replace this node with a given sequence of nodesvoid
replaceStringValue(java.lang.CharSequence stringValue)
Replace the string-value of this node.void
setTypeAnnotation(int typeCode)
Set the type annotation on a node.-
Methods inherited from class net.sf.saxon.tree.linked.NodeImpl
addAttribute, addNamespace, atomize, compareOrder, equals, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getFirstChild, getLastChild, getLineNumber, getLocalPart, getNamePool, getParent, getPhysicalRoot, getPrefix, getPublicId, getRawParent, getRoot, getSiblingPosition, getStringValueCS, getSystemId, getTypedValue, getURI, hasChildNodes, insertChildren, insertSiblings, iterateAxis, iterateAxis, newBuilder, removeAttribute, setRawParent, setSiblingPosition, setSystemId
-
-
-
-
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 attributeindex
- The index position of the attribute starting at zero
-
-
Method Detail
-
getNameCode
public int getNameCode()
Get the name code, which enables the name to be located in the name pool- Specified by:
getNameCode
in interfaceNodeInfo
- Overrides:
getNameCode
in classNodeImpl
- Returns:
- an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
- See Also:
allocate
,getFingerprint
-
getTypeAnnotation
public int getTypeAnnotation()
Get the fingerprint of the type annotation of this node, if any- Specified by:
getTypeAnnotation
in interfaceNodeInfo
- Overrides:
getTypeAnnotation
in classNodeImpl
- Returns:
- the type annotation, as the integer name code of the type name
-
getSchemaType
public SchemaType getSchemaType()
Get the type annotation- Specified by:
getSchemaType
in interfaceNodeInfo
- Overrides:
getSchemaType
in classNodeImpl
- Returns:
- the type annotation of the node, if any
-
isId
public boolean isId()
Determine whether this node has the is-id property
-
isIdref
public boolean isIdref()
Determine whether this node has the is-idref property
-
isNilled
public boolean isNilled()
Determine whether the node has the is-nilled property
-
isSameNodeInfo
public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node- Specified by:
isSameNodeInfo
in interfaceNodeInfo
- Overrides:
isSameNodeInfo
in classNodeImpl
- Parameters:
other
- the node to be compared with this node- Returns:
- true if this Node object and the supplied Node object represent the same node in the tree.
-
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()- Specified by:
hashCode
in interfaceNodeInfo
- Overrides:
hashCode
in classjava.lang.Object
- 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.
-
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.- Overrides:
getSequenceNumber
in classNodeImpl
- Returns:
- the sequence number if there is one, or -1L otherwise.
-
getNodeKind
public final int getNodeKind()
Return the type of node.- Returns:
- Node.ATTRIBUTE
- See Also:
Type
-
getStringValue
public java.lang.String getStringValue()
Return the character value of the node.- Returns:
- the attribute value
- See Also:
Item.getStringValueCS()
-
getNextSibling
public NodeInfo getNextSibling()
Get next sibling - not defined for attributes- Overrides:
getNextSibling
in classNodeImpl
- Returns:
- The next sibling node of the required type. Returns null if the current node is the last child of its parent.
-
getPreviousSibling
public NodeInfo getPreviousSibling()
Get previous sibling - not defined for attributes- Overrides:
getPreviousSibling
in classNodeImpl
- Returns:
- The previous sibling node. Returns null if the current node is the first child of its parent.
-
getPreviousInDocument
public NodeImpl getPreviousInDocument()
Get the previous node in document order (skipping attributes)- Overrides:
getPreviousInDocument
in classNodeImpl
- Returns:
- the previous node in the document, or null if there is no such node
-
getNextInDocument
public NodeImpl getNextInDocument(NodeImpl anchor)
Get the next node in document order (skipping attributes)- Overrides:
getNextInDocument
in classNodeImpl
- Parameters:
anchor
- the scan stops when it reaches a node that is not a descendant of the specified anchor node- Returns:
- the next node in the document, or null if there is no such node
-
generateId
public void generateId(FastStringBuffer buffer)
Get sequential key. Returns key of owning element with the attribute index as a suffix- Specified by:
generateId
in interfaceNodeInfo
- Overrides:
generateId
in classNodeImpl
- Parameters:
buffer
- a buffer to which the generated ID will be written
-
copy
public void copy(Receiver out, int copyOptions, int locationId) throws XPathException
Copy this node to a given outputter- Parameters:
out
- the Receiver to which the node should be copied. It is the caller's responsibility to ensure that this Receiver is open before the method is called (or that it is self-opening), and that it is closed after use.copyOptions
- a selection of the options defined inCopyOptions
locationId
- If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information- Throws:
XPathException
- if any downstream error occurs
-
delete
public void delete()
Delete this node (that is, detach it from its parent)- Specified by:
delete
in interfaceMutableNodeInfo
- Overrides:
delete
in classNodeImpl
-
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- Specified by:
isDeleted
in interfaceMutableNodeInfo
- Overrides:
isDeleted
in classNodeImpl
- Returns:
- true if this node has been deleted
-
replace
public void replace(NodeInfo[] replacement, boolean inherit)
Replace this node with a given sequence of nodes- Specified by:
replace
in interfaceMutableNodeInfo
- Overrides:
replace
in classNodeImpl
- Parameters:
replacement
- the replacement nodes (which for this version of the method must be attribute nodes - they may use any implementation of the NodeInfo interface). 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:
java.lang.IllegalArgumentException
- if any of the replacement nodes is not an attributejava.lang.IllegalStateException
- if this node has been deleted or has no parent node or if two of the replacement nodes have the same name
-
rename
public void rename(NodeName newNameCode)
Rename this node- Specified by:
rename
in interfaceMutableNodeInfo
- Overrides:
rename
in classNodeImpl
- Parameters:
newNameCode
- the NamePool code of the new name
-
replaceStringValue
public void replaceStringValue(java.lang.CharSequence stringValue)
Description copied from interface:MutableNodeInfo
Replace the string-value of this node. If applied to an element or document node, this causes all existing children to be deleted, and replaced with a new text node whose string value is the value supplied. The caller is responsible for checking that the value is valid, for example that comments do not contain a double hyphen; the implementation is not required to check for such conditions.- Parameters:
stringValue
- the new string value
-
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- Specified by:
removeTypeAnnotation
in interfaceMutableNodeInfo
- Overrides:
removeTypeAnnotation
in classNodeImpl
-
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.- Specified by:
setTypeAnnotation
in interfaceMutableNodeInfo
- Overrides:
setTypeAnnotation
in classNodeImpl
- Parameters:
typeCode
- the type annotation (possibly including high bits set to indicate the isID, isIDREF, and isNilled properties)
-
-