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, Location, FingerprintedNode, Item, NodeInfo, Sequence, Locator

public 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, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
TinyAttributeImpl(TinyTree tree, int nodeNr)

Method Summary

Methods

Modifier and Type	Method and Description
AtomicSequence	atomize() Get the typed value.
void	copy(Receiver out, int copyOptions, Location 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)
SchemaType	getSchemaType() Get the type annotation of this node, if any.
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.
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	isDefaultedAttribute() Ask whether the attribute results from expansion of attribute defaults
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, comparePosition, equals, getAttributeValue, getAttributeValue, getBaseURI, getConfiguration, getDeclaredNamespaces, getNamePool, getNodeNumber, getPublicId, getSystemId, getTree, getTreeInfo, hasChildNodes, head, isAncestorOrSelf, isSameNodeInfo, iterate, iterateAxis, iterateAxis, saveLocation, 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

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 FingerprintedNode

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 FingerprintedNode

Overrides:

getNameCode in class TinyNodeImpl

Returns:

an integer name code; two nodes with the same name code have the same prefix, local name, and namespace URI. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.

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

getSchemaType

public SchemaType getSchemaType()

Get the type annotation of this node, if any. The type annotation is represented as SchemaType object.

Types derived from a DTD are not reflected in the result of this method.

Specified by:

getSchemaType in interface NodeInfo

Overrides:

getSchemaType in class TinyNodeImpl

Returns:

For element and attribute nodes: the type annotation derived from schema validation (defaulting to xs:untyped and xs:untypedAtomic in the absence of schema validation). For comments, text nodes, processing instructions, and namespaces: null. For document nodes, either xs:untyped if the document has not been validated, or xs:anyType if it has.

Since:

9.4

atomize

public AtomicSequence atomize()
                       throws XPathException

Get the typed value.

Returns:

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

Throws:

XPathException - if the node has no typed value, for example if it is an element node with element-only content

Since:

8.5

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,
        Location 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-null, identifies the location of the instruction that requested this copy. If zero, indicates that the location information is not available

Throws:

XPathException - if any downstream error occurs

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 Location

Specified by:

getLineNumber in interface NodeInfo

Specified by:

getLineNumber in interface Locator

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 Location

Specified by:

getColumnNumber in interface NodeInfo

Specified by:

getColumnNumber in interface Locator

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

isDefaultedAttribute

public boolean isDefaultedAttribute()

Ask whether the attribute results from expansion of attribute defaults

Returns:

true if this attribute resulted from expansion of default or fixed values defined in a schema. Note that this property will only be set if both the configuration properties FeatureKeys.EXPAND_ATTRIBUTE_DEFAULTS and FeatureKeys.MARK_DEFAULTED_ATTRIBUTES are set.

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.