net.sf.saxon.option.axiom

Class AxiomAttributeWrapper

java.lang.Object

net.sf.saxon.option.axiom.AxiomAttributeWrapper

All Implemented Interfaces:

java.lang.Iterable<NodeInfo>, javax.xml.transform.Source, javax.xml.transform.SourceLocator, Location, GroundedValue<NodeInfo>, Item<NodeInfo>, NodeInfo, Sequence<NodeInfo>, SiblingCountingNode, VirtualNode, org.xml.sax.Locator

public class AxiomAttributeWrapper
extends java.lang.Object
implements NodeInfo, VirtualNode, SiblingCountingNode

A node in the XML parse tree representing an XML element, character content, or attribute.

This is the implementation of the NodeInfo interface used as a wrapper for Axiom nodes.

Note that in Axiom, an OMAttribute is not an OMNode. Therefore, we need a separate class AttributeWrapper for attribute nodes.

Author:

Michael H. Kay

Field Summary

Fields

Modifier and Type	Field and Description
protected int	index
protected org.apache.axiom.om.OMAttribute	node

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

IS_DTD_TYPE, IS_NILLED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AxiomAttributeWrapper(org.apache.axiom.om.OMAttribute node, AxiomParentNodeWrapper parent, int index) This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class

Method Summary

Modifier and Type	Method and Description
AtomicSequence	atomize() Get the typed value.
int	compareOrder(NodeInfo other) Determine the relative position of this node and another node, in document order.
boolean	equals(java.lang.Object other) The equals() method compares nodes for identity.
void	generateId(FastStringBuffer buffer) Get a character string that uniquely identifies this node.
java.lang.String	getAttributeValue(java.lang.String uri, java.lang.String local) Get the string value of a given attribute of this node
java.lang.String	getBaseURI() Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.
Configuration	getConfiguration() Get the configuration
NamespaceBinding[]	getDeclaredNamespaces(NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.
java.lang.String	getDisplayName() Get the display name of this node.
int	getFingerprint() Get fingerprint.
java.lang.String	getLocalPart() Get the local part of the name of this node.
int	getNodeKind() Return the type of node.
NodeInfo	getParent() Get the NodeInfo object representing the parent of this node
java.lang.String	getPrefix() Get the prefix of the name of the node.
org.apache.axiom.om.OMAttribute	getRealNode() Get the node underlying this virtual node.
NodeInfo	getRoot() Get the root node of the tree containing this node
SchemaType	getSchemaType() Get the type annotation of this node, if any.
int	getSiblingPosition() Get the index position of this node among its siblings (starting from 0)
java.lang.String	getStringValue() Return the string value of the node.
java.lang.CharSequence	getStringValueCS() Get the value of the item as a CharSequence.
java.lang.String	getSystemId() Get the System ID for the node.
TreeInfo	getTreeInfo() Get information about the tree to which this NodeInfo belongs
org.apache.axiom.om.OMAttribute	getUnderlyingNode() Get the underlying Axiom node, to implement the VirtualNode interface
java.lang.String	getURI() Get the URI part of the name of this node.
boolean	hasChildNodes() Determine whether the node has any children.
boolean	hasFingerprint() Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the node in the NamePool.
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
AxisIterator	iterateAxis(byte axisNumber, NodeTest nodeTest) Return an iteration over the nodes reached by the given axis from this node
Location	saveLocation() Get an immutable copy of this Location object.
void	setSystemId(java.lang.String uri)

Methods inherited from class java.lang.Object

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

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

copy, getColumnNumber, getGenre, getLineNumber, getPublicId, isNilled, isSameNodeInfo, isStreamed, iterateAxis, toShortString

Methods inherited from interface net.sf.saxon.om.Item

getLength, head, itemAt, iterate, iterator, reduce, subsequence, toGroundedValue

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, effectiveBooleanValue, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

node

protected org.apache.axiom.om.OMAttribute node

index

protected int index

Constructor Detail

AxiomAttributeWrapper

protected AxiomAttributeWrapper(org.apache.axiom.om.OMAttribute node,
                                AxiomParentNodeWrapper parent,
                                int index)

This constructor is protected: nodes should be created using the wrap factory method on the DocumentWrapper class

Parameters:

node - The Axiom attribute node to be wrapped

parent - The NodeWrapper that wraps the parent of this attribute node

index - Position of this node among its siblings

Method Detail

getTreeInfo

public TreeInfo getTreeInfo()

Get information about the tree to which this NodeInfo belongs

Specified by:

getTreeInfo in interface NodeInfo

Returns:

the TreeInfo

Since:

9.7

getConfiguration

public Configuration getConfiguration()

Get the configuration

Specified by:

getConfiguration in interface NodeInfo

Returns:

the Configuration to which the tree belongs. The default implementation invokes getTreeInfo().getConfiguration().

getUnderlyingNode

public org.apache.axiom.om.OMAttribute getUnderlyingNode()

Get the underlying Axiom node, to implement the VirtualNode interface

Specified by:

getUnderlyingNode in interface VirtualNode

Returns:

The underlying node.

getRealNode

public org.apache.axiom.om.OMAttribute getRealNode()

Get the node underlying this virtual node. If this is a VirtualNode the method will automatically drill down through several layers of wrapping.

Specified by:

getRealNode in interface VirtualNode

Returns:

The underlying node.

getFingerprint

public int getFingerprint()

Get fingerprint. The fingerprint is a coded form of the expanded name of the node: two nodes with the same name code have the same namespace URI and the same local name. The fingerprint contains no information about the namespace prefix. For a name in the null namespace, the fingerprint is the same as the name code.

Specified by:

getFingerprint in interface NodeInfo

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.

Throws:

java.lang.UnsupportedOperationException - if this kind of node does not hold namepool fingerprints (specifically, if hasFingerprint() returns false).

Since:

8.4 (moved into FingerprintedNode at some stage; then back into NodeInfo at 9.8).

hasFingerprint

public boolean hasFingerprint()

Ask whether this NodeInfo implementation holds a fingerprint identifying the name of the node in the NamePool. If the answer is true, then the getFingerprint() method must return the fingerprint of the node. If the answer is false, then the getFingerprint() method should throw an UnsupportedOperationException. In the case of unnamed nodes such as text nodes, the result can be either true (in which case getFingerprint() should return -1) or false (in which case getFingerprint may throw an exception).

Specified by:

hasFingerprint in interface NodeInfo

Returns:

true if the implementation of this node provides fingerprints.

Since:

9.8; previously Saxon relied on using FingerprintedNode as a marker interface.

getNodeKind

public int getNodeKind()

Return the type of node.

Specified by:

getNodeKind in interface NodeInfo

Returns:

one of the values Node.ELEMENT, Node.TEXT, Node.ATTRIBUTE, etc.

See Also:

Type

atomize

public AtomicSequence atomize()

Get the typed value.

Specified by:

atomize in interface Item<NodeInfo>

Specified by:

atomize in interface NodeInfo

Returns:

the typed value. If requireSingleton is set to true, the result will always be an AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic values.

Since:

8.5 (signature changed in 9.5)

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

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

equals

public boolean equals(java.lang.Object other)

The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().

Specified by:

equals in interface NodeInfo

Overrides:

equals in class java.lang.Object

Parameters:

other - the node to be compared with this node

Returns:

true if this NodeInfo object and the supplied NodeInfo object represent the same node in the tree.

Since:

8.7 Previously, the effect of the equals() method was not defined. Callers should therefore be aware that third party implementations of the NodeInfo interface may not implement the correct semantics. It is safer to use isSameNodeInfo() for this reason. The equals() method has been defined because it is useful in contexts such as a Java Set or HashMap.

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

getSystemId

public java.lang.String getSystemId()

Get the System ID for the node.

Specified by:

getSystemId in interface javax.xml.transform.Source

Specified by:

getSystemId in interface javax.xml.transform.SourceLocator

Specified by:

getSystemId in interface Location

Specified by:

getSystemId in interface NodeInfo

Specified by:

getSystemId in interface org.xml.sax.Locator

Returns:

the System Identifier of the entity in the source document containing the node, or null if not known. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot.

setSystemId

public void setSystemId(java.lang.String uri)

Specified by:

setSystemId in interface javax.xml.transform.Source

getBaseURI

public java.lang.String getBaseURI()

Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.

Specified by:

getBaseURI in interface NodeInfo

Returns:

the base URI of the node. This may be null if the base URI is unknown, including the case where the node has no parent.

saveLocation

public Location saveLocation()

Get an immutable copy of this Location object. By default Location objects may be mutable, so they should not be saved for later use. The result of this operation holds the same location information, but in an immutable form.

Specified by:

saveLocation in interface Location

compareOrder

public int compareOrder(NodeInfo other)

Determine the relative position of this node and another node, in document order. The other node will always be in the same document.

Specified by:

compareOrder in interface NodeInfo

Parameters:

other - The other node, whose position is to be compared with this node

Returns:

-1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())

getStringValue

public java.lang.String getStringValue()

Return the string value of the node. The interpretation of this depends on the type of node. For an element it is the accumulated character content of the element, including descendant elements.

Specified by:

getStringValue in interface GroundedValue<NodeInfo>

Specified by:

getStringValue in interface Item<NodeInfo>

Specified by:

getStringValue in interface NodeInfo

Returns:

the string value of the node

See Also:

Item.getStringValueCS()

getStringValueCS

public java.lang.CharSequence getStringValueCS()

Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.

Specified by:

getStringValueCS in interface GroundedValue<NodeInfo>

Specified by:

getStringValueCS in interface Item<NodeInfo>

Returns:

the string value of the item

See Also:

Item.getStringValue()

getLocalPart

public java.lang.String getLocalPart()

Get the local part of the name of this node. This is the name after the ":" if any.

Specified by:

getLocalPart in interface NodeInfo

Returns:

the local part of the name. For an unnamed node, returns "".

getPrefix

public java.lang.String getPrefix()

Get the prefix of the name of the node. This is defined only for elements and attributes. If the node has no prefix, or for other kinds of node, return a zero-length string.

Specified by:

getPrefix in interface NodeInfo

Returns:

The prefix of the name of the node.

getURI

public java.lang.String getURI()

Get the URI part of the name of this node. This is the URI corresponding to the prefix, or the URI of the default namespace if appropriate.

Specified by:

getURI in interface NodeInfo

Returns:

The URI of the namespace of this node. For an unnamed node, or for a node with an empty prefix, return an empty string.

getDisplayName

public java.lang.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

Returns:

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

getParent

public NodeInfo getParent()

Get the NodeInfo object representing the parent of this node

Specified by:

getParent in interface NodeInfo

Returns:

the parent of this node; null if this node has no parent

getSiblingPosition

public int getSiblingPosition()

Get the index position of this node among its siblings (starting from 0)

Specified by:

getSiblingPosition in interface SiblingCountingNode

Returns:

0 for the first child, 1 for the second child, etc.

iterateAxis

public AxisIterator iterateAxis(byte axisNumber,
                                NodeTest nodeTest)

Return an iteration over the nodes reached by the given axis from this node

Specified by:

iterateAxis in interface NodeInfo

Parameters:

axisNumber - the axis to be used

nodeTest - A pattern to be matched by the returned nodes

Returns:

a SequenceIterator that scans the nodes reached by the axis in turn.

See Also:

AxisInfo

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String uri,
                                          java.lang.String local)

Get the string value of a given attribute of this node

Specified by:

getAttributeValue in interface NodeInfo

Parameters:

uri - the namespace URI of the attribute name. Supply the empty string for an attribute that is in no namespace

local - the local part of the attribute name.

Returns:

the attribute value if it exists, or null if it does not exist. Always returns null if this node is not an element.

Since:

9.4

getRoot

public NodeInfo getRoot()

Get the root node of the tree containing this node

Specified by:

getRoot in interface NodeInfo

Returns:

the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node

hasChildNodes

public boolean hasChildNodes()

Determine whether the node has any children.

Note: the result is equivalent to getEnumeration(Axis.CHILD, AnyNodeTest.getInstance()).hasNext()

Specified by:

hasChildNodes in interface NodeInfo

Returns:

True if the node has one or more children

generateId

public void generateId(FastStringBuffer buffer)

Get a character string that uniquely identifies this node. Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)

Specified by:

generateId in interface NodeInfo

Parameters:

buffer - a buffer to contain a string that uniquely identifies this node, across all documents

getDeclaredNamespaces

public NamespaceBinding[] getDeclaredNamespaces(NamespaceBinding[] buffer)

Get all namespace undeclarations and undeclarations defined on this element.

Specified by:

getDeclaredNamespaces in interface NodeInfo

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.

isId

public boolean isId()

Determine whether this node has the is-id property

Specified by:

isId in interface NodeInfo

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

Returns:

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