net.sf.saxon.tree.tiny

Class TinyAttributeImpl

java.lang.Object

net.sf.saxon.tree.tiny.TinyNodeImpl

net.sf.saxon.tree.tiny.TinyAttributeImpl

All Implemented Interfaces:

Source, SourceLocator, PullEvent, FingerprintedNode, Item, NodeInfo, ValueRepresentation

final class TinyAttributeImpl
extends TinyNodeImpl

A node in the XML parse tree representing an attribute. Note that this is generated only "on demand", when the attribute is selected by a select pattern.

Author:

Michael H. Kay

Field Summary

Fields inherited from class net.sf.saxon.tree.tiny.TinyNodeImpl

NODE_LETTER, nodeNr, parent, tree

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, 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 and Description
TinyAttributeImpl(TinyTree tree, int nodeNr)

Method Summary

Modifier and Type	Method and Description
Value	atomize() Get the typed value.
void	copy(Receiver out, int copyOptions, int locationId) Copy this node to a given outputter
void	generateId(FastStringBuffer buffer) Generate id.
int	getColumnNumber() Get the column number of the node within its source document entity
String	getDisplayName() Get the display name of this node.
int	getFingerprint() Get the fingerprint of the node, used for matching names
int	getLineNumber() Get the line number of the node within its source document entity
String	getLocalPart() Get the local name of this node.
int	getNameCode() Get the name code of the node, used for finding names in the name pool
int	getNodeKind() Return the type of node.
NodeInfo	getParent() Get the parent node
String	getPrefix() Get the prefix part of the name of this node.
NodeInfo	getRoot() Get the root node of the tree (not necessarily a document node)
protected long	getSequenceNumber() Get the node sequence number (in document order).
String	getStringValue() Return the string value of the node.
CharSequence	getStringValueCS() Return the string value of the node.
int	getTypeAnnotation() Get the type annotation of this node, if any The bit NodeInfo.IS_DTD_TYPE (1<<30) will be set in the case of an attribute node if the type annotation is one of ID, IDREF, or IDREFS and this is derived from DTD rather than schema validation.
SequenceIterator	getTypedValue() Get the typed value of the item.
String	getURI() Get the URI part of the name of this node.
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()
boolean	isId() Determine whether this node has the is-id property
boolean	isIdref() Determine whether this node has the is-idref property
boolean	isNilled() Determine whether the node has the is-nilled property
void	setSystemId(String uri) Set the system id of this node.

Methods inherited from class net.sf.saxon.tree.tiny.TinyNodeImpl

compareOrder, equals, getAttributeValue, getBaseURI, getConfiguration, getDeclaredNamespaces, getDocumentNumber, getDocumentRoot, getNamePool, getNodeNumber, getParentNodeNr, getPublicId, getSystemId, getTree, hasChildNodes, isAncestorOrSelf, isSameNodeInfo, iterateAxis, iterateAxis, setParentNode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TinyAttributeImpl

public TinyAttributeImpl(TinyTree tree,
                         int nodeNr)

Method Detail

setSystemId

public void setSystemId(String uri)

Description copied from class: TinyNodeImpl

Set the system id of this node.
This method is present to ensure that the class implements the javax.xml.transform.Source interface, so a node can be used as the source of a transformation.

Specified by:

setSystemId in interface Source

Overrides:

setSystemId in class TinyNodeImpl

getParent

public NodeInfo getParent()

Get the parent node

Specified by:

getParent in interface NodeInfo

Overrides:

getParent in class TinyNodeImpl

Returns:

The Node object describing the containing element or root node.

getRoot

public NodeInfo getRoot()

Get the root node of the tree (not necessarily a document node)

Specified by:

getRoot in interface NodeInfo

Overrides:

getRoot in class TinyNodeImpl

Returns:

the NodeInfo representing the root of this tree

getSequenceNumber

protected long getSequenceNumber()

Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In this implementation, elements have a zero least-significant word, while attributes and namespaces use the same value in the top word as the containing element, and use the bottom word to hold a sequence number, which numbers namespaces first and then attributes.

Overrides:

getSequenceNumber in class TinyNodeImpl

Returns:

the sequence number

getNodeKind

public final int getNodeKind()

Return the type of node.

Returns:

Node.ATTRIBUTE

See Also:

Type

getStringValueCS

public CharSequence getStringValueCS()

Return the string value of the node.

Specified by:

getStringValueCS in interface Item

Specified by:

getStringValueCS in interface ValueRepresentation

Overrides:

getStringValueCS in class TinyNodeImpl

Returns:

the attribute value

See Also:

Item.getStringValue()

getStringValue

public String getStringValue()

Return the string value of the node.

Returns:

the attribute value

See Also:

Item.getStringValueCS()

getFingerprint

public int getFingerprint()

Get the fingerprint of the node, used for matching names

Specified by:

getFingerprint in interface NodeInfo

Overrides:

getFingerprint in class TinyNodeImpl

Returns:

an integer fingerprint; two nodes with the same fingerprint have the same expanded QName. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.

getNameCode

public int getNameCode()

Get the name code of the node, used for finding names in the name pool

Specified by:

getNameCode in interface NodeInfo

Overrides:

getNameCode in class TinyNodeImpl

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

getPrefix

public String getPrefix()

Get the prefix part of the name of this node. This is the name before the ":" if any.

Specified by:

getPrefix in interface NodeInfo

Overrides:

getPrefix in class TinyNodeImpl

Returns:

the prefix part of the name. For an unnamed node, return null.

getDisplayName

public String getDisplayName()

Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.

Specified by:

getDisplayName in interface NodeInfo

Overrides:

getDisplayName in class TinyNodeImpl

Returns:

The display name of this node. For a node with no name, return an empty string.

getLocalPart

public String getLocalPart()

Get the local name of this node.

Specified by:

getLocalPart in interface NodeInfo

Overrides:

getLocalPart in class TinyNodeImpl

Returns:

The local name of this node. For a node with no name, return an empty string.

getURI

public final String getURI()

Get the URI part of the name of this node.

Specified by:

getURI in interface NodeInfo

Overrides:

getURI in class TinyNodeImpl

Returns:

The URI of the namespace of this node. For the default namespace, return an empty string

getTypeAnnotation

public int getTypeAnnotation()

Get the type annotation of this node, if any The bit NodeInfo.IS_DTD_TYPE (1<<30) will be set in the case of an attribute node if the type annotation is one of ID, IDREF, or IDREFS and this is derived from DTD rather than schema validation. Returns UNTYPED_ATOMIC if there is no type annotation

Specified by:

getTypeAnnotation in interface NodeInfo

Overrides:

getTypeAnnotation in class TinyNodeImpl

Returns:

the type annotation of the node, under the mask NamePool.FP_MASK, and optionally the bit setting IS_DTD_TYPE in the case of a DTD-derived ID or IDREF/S type (which is treated as untypedAtomic for the purposes of obtaining the typed value).

For elements and attributes, this is the type annotation as defined in XDM. For document nodes, it should be one of XS_UNTYPED if the document has not been validated, or XS_ANY_TYPE if validation has taken place (that is, if any node in the document has an annotation other than Untyped or UntypedAtomic).

atomize

public Value atomize()
              throws XPathException

Get the typed value. The result of this method will always be consistent with the method Item.getTypedValue(). However, this method is often more convenient and may be more efficient, especially in the common case where the value is expected to be a singleton.

Returns:

the typed value. This will either be a single AtomicValue or a Value whose items are atomic values.

Throws:

XPathException

Since:

8.5

getTypedValue

public SequenceIterator getTypedValue()
                               throws XPathException

Get the typed value of the item.

For a node, this is the typed value as defined in the XPath 2.0 data model. Since a node may have a list-valued data type, the typed value is in general a sequence, and it is returned in the form of a SequenceIterator.

If the node has not been validated against a schema, the typed value will be the same as the string value, either as an instance of xs:string or as an instance of xs:untypedAtomic, depending on the node kind.

For an atomic value, this method returns an iterator over a singleton sequence containing the atomic value itself.

Returns:

an iterator over the items in the typed value of the node or atomic value. The items returned by this iterator will always be atomic values.

Throws:

XPathException - where no typed value is available, for example in the case of an element with complex content

Since:

8.4

generateId

public void generateId(FastStringBuffer buffer)

Generate id. Returns key of owning element with the attribute namecode as a suffix

Specified by:

generateId in interface NodeInfo

Overrides:

generateId in class TinyNodeImpl

Parameters:

buffer - Buffer to contain the generated ID value

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 in CopyOptions

locationId - If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information

Throws:

XPathException

getLineNumber

public int getLineNumber()

Get the line number of the node within its source document entity

Specified by:

getLineNumber in interface SourceLocator

Specified by:

getLineNumber in interface NodeInfo

Overrides:

getLineNumber in class TinyNodeImpl

Returns:

the line number of the node in its original source document; or -1 if not available

getColumnNumber

public int getColumnNumber()

Get the column number of the node within its source document entity

Specified by:

getColumnNumber in interface SourceLocator

Specified by:

getColumnNumber in interface NodeInfo

Overrides:

getColumnNumber in class TinyNodeImpl

Returns:

the column number of the node in its original source document; or -1 if not available

isNilled

public boolean isNilled()

Determine whether the node has the is-nilled property

Specified by:

isNilled in interface NodeInfo

Overrides:

isNilled in class TinyNodeImpl

Returns:

true if the node has the is-nilled property

isId

public boolean isId()

Determine whether this node has the is-id property

Specified by:

isId in interface NodeInfo

Overrides:

isId in class TinyNodeImpl

Returns:

true if the node is an ID

isIdref

public boolean isIdref()

Determine whether this node has the is-idref property

Specified by:

isIdref in interface NodeInfo

Overrides:

isIdref in class TinyNodeImpl

Returns:

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

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 interface NodeInfo

Overrides:

hashCode in class TinyNodeImpl

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.