Class Orphan
- All Implemented Interfaces:
Source
,PullEvent
,FingerprintedNode
,Item<NodeInfo>
,MutableNodeInfo
,NodeInfo
,ValueRepresentation<NodeInfo>
In general this class does not impose constraints defined in the data model: that is the responsibility of the client. For example, the class does not prevent you from creating a comment or text node that has a name or a non-trivial type annotation.
- Author:
- Michael H. Kay
-
Field Summary
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(NodeName nameCode, SimpleType attType, CharSequence value, int properties) Add an attribute to this element node.void
addNamespace
(NamespaceBinding nscode, boolean inherit) Add a namespace binding (that is, a namespace node) to this element.atomize()
Get the typed value.int
compareOrder
(NodeInfo other) Determine the relative position of this node and another node, in document order.void
Copy this node to a given outputter (deep copy)void
delete()
Delete this node (that is, detach it from its parent).boolean
The equals() method compares nodes for identity.void
generateId
(FastStringBuffer buffer) Get a character string that uniquely identifies this node.getAttributeValue
(int fingerprint) Get the value of a given attribute of this nodegetAttributeValue
(String uri, String local) Get the string value of a given attribute of this nodeGet the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node.int
Get column numberGet the configurationgetDeclaredNamespaces
(NamespaceBinding[] buffer) Get all namespace undeclarations and undeclarations defined on this element.Get the display name of this node.long
Get the document number of the document containing this node.Get the root (document) nodeint
Get fingerprint.int
Get line numberGet the local part of the name of this node.int
Get name code.Get the name poolint
Return the kind of node.Get the NodeInfo object representing the parent of this nodeGet the prefix of the name of the node.getRoot()
Get the root node of this tree (not necessarily a document node).Get the type annotation of this node, if any.Return the string value of the node.Get the value of the item as a CharSequence.Get the System ID for the node.int
Get the type annotationSequenceIterator<? extends AtomicValue>
Get the typed value of the nodegetURI()
Get the URI part of the name of this node.boolean
Determine whether the node has any children.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()void
insertChildren
(NodeInfo[] source, boolean atStart, boolean inherit) Insert copies of a sequence of nodes as children of this node.void
insertSiblings
(NodeInfo[] source, boolean before, boolean inherit) Insert copies of a sequence of nodes as siblings of this node.boolean
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 node.iterateAxis
(byte axisNumber) Return an iteration over the nodes reached by the given axis from this nodeiterateAxis
(byte axisNumber, NodeTest nodeTest) Return an iteration over the nodes reached by the given axis from this nodeGet a Builder suitable for building nodes that can be attached to this document.void
removeAttribute
(NodeInfo attribute) Remove an attribute from this element nodevoid
Remove type information from this node (and its ancestors, recursively).void
Rename this node.void
Replace this node with a given sequence of nodesvoid
replaceStringValue
(CharSequence stringValue) Replace the string-value of this node.void
setIsId
(boolean id) Set the isId propertyvoid
setIsIdref
(boolean idref) Set the isIdref propertyvoid
setNodeKind
(short kind) Set the node kindvoid
setNodeName
(NodeName nodeName) Set the name of the nodevoid
setStringValue
(CharSequence stringValue) Set the string value of the nodevoid
setSystemId
(String systemId) Set the base URI of the nodevoid
setTypeAnnotation
(int typeAnnotation) Set the type annotation of the nodevoid
setTypeAnnotation
(SchemaType typeAnnotation) Set the type annotation of the node
-
Constructor Details
-
Orphan
Create an Orphan node- Parameters:
config
- the Saxon configuration
-
-
Method Details
-
setNodeKind
public void setNodeKind(short kind) Set the node kind- Parameters:
kind
- the kind of node, for exampleType.ELEMENT
orType.ATTRIBUTE
-
setNodeName
Set the name of the node- Parameters:
nodeName
- the name of the node. May be null for unnamed nodes such as text and comment nodes
-
setStringValue
Set the string value of the node- Parameters:
stringValue
- the string value of the node
-
setTypeAnnotation
Set the type annotation of the node- Parameters:
typeAnnotation
- the type annotation
-
setTypeAnnotation
public void setTypeAnnotation(int typeAnnotation) Set the type annotation of the node- Specified by:
setTypeAnnotation
in interfaceMutableNodeInfo
- Parameters:
typeAnnotation
- the type annotation
-
setSystemId
Set the base URI of the node- Specified by:
setSystemId
in interfaceSource
- Parameters:
systemId
- the base URI of the node
-
setIsId
public void setIsId(boolean id) Set the isId property- Parameters:
id
- the isId property
-
setIsIdref
public void setIsIdref(boolean idref) Set the isIdref property- Parameters:
idref
- the isIdref property
-
getNodeKind
public int getNodeKind()Return the kind of node.- Specified by:
getNodeKind
in interfaceNodeInfo
- Returns:
- one of the values Type.ELEMENT, Type.TEXT, Type.ATTRIBUTE, etc.
- See Also:
-
getTypedValue
Get the typed value of the node- Specified by:
getTypedValue
in interfaceItem<NodeInfo>
- Returns:
- an iterator over the items making up the typed value
- Throws:
XPathException
- where no typed value is available, for example in the case of an element with complex content
-
atomize
Get the typed value. The result of this method will always be consistent with the methodItem.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.- Specified by:
atomize
in interfaceNodeInfo
- 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.
- Throws:
XPathException
- if the node has no typed value, for example if it is an element node with element-only content- Since:
- 8.5
-
getConfiguration
Get the configuration- Specified by:
getConfiguration
in interfaceNodeInfo
- Returns:
- the Saxon configuration object
-
getNamePool
Get the name pool- Specified by:
getNamePool
in interfaceNodeInfo
- Returns:
- the namepool
-
getTypeAnnotation
public int getTypeAnnotation()Get the type annotation- Specified by:
getTypeAnnotation
in interfaceNodeInfo
- 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).
-
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 interfaceNodeInfo
- 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
-
isSameNodeInfo
Determine whether this is the same node as another node.
Note: a.isSameNode(b) if and only if generateId(a)==generateId(b)- Specified by:
isSameNodeInfo
in interfaceNodeInfo
- 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.
-
equals
The equals() method compares nodes for identity. It is defined to give the same result as isSameNodeInfo().- Specified by:
equals
in interfaceNodeInfo
- Overrides:
equals
in classObject
- 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 interfaceNodeInfo
- Overrides:
hashCode
in classObject
- 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
Get the System ID for the node.- Specified by:
getSystemId
in interfaceNodeInfo
- Specified by:
getSystemId
in interfaceSource
- 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.
-
getBaseURI
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained in the node. This will be the same as the System ID unless xml:base has been used.- Specified by:
getBaseURI
in interfaceNodeInfo
- 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.
-
getLineNumber
public int getLineNumber()Get line number- Specified by:
getLineNumber
in interfaceNodeInfo
- Returns:
- the line number of the node in its original source document; or -1 if not available
-
getColumnNumber
public int getColumnNumber()Get column number- Specified by:
getColumnNumber
in interfaceNodeInfo
- Returns:
- the column number of the node in its original source document; or -1 if not available
-
compareOrder
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 interfaceNodeInfo
- 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
Return the string value of the node.- Specified by:
getStringValue
in interfaceItem<NodeInfo>
- Specified by:
getStringValue
in interfaceNodeInfo
- Specified by:
getStringValue
in interfaceValueRepresentation<NodeInfo>
- Returns:
- the string value of the node
- See Also:
-
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 interfaceItem<NodeInfo>
- Specified by:
getStringValueCS
in interfaceValueRepresentation<NodeInfo>
- Returns:
- the string value of the item
- See Also:
-
getNameCode
public int getNameCode()Get name code. The name code is a coded form of the node name: two nodes with the same name code have the same namespace URI, the same local name, and the same prefix. By masking the name code with &0xfffff, you get a fingerprint: two nodes with the same fingerprint have the same local name and namespace URI.- Specified by:
getNameCode
in interfaceNodeInfo
- 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:
-
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. A fingerprint of -1 should be returned for a node with no name.- Specified by:
getFingerprint
in interfaceNodeInfo
- 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.
-
getLocalPart
Get the local part of the name of this node. This is the name after the ":" if any.- Specified by:
getLocalPart
in interfaceNodeInfo
- Returns:
- the local part of the name. For an unnamed node, returns "".
-
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. -
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. -
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 interfaceNodeInfo
- Returns:
- The display name of this node. For a node with no name, return an empty string.
-
getParent
Get the NodeInfo object representing the parent of this node -
iterateAxis
Return an iteration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- the axis to be searched, e.g. Axis.CHILD or Axis.ANCESTOR- Returns:
- a SequenceIterator that scans the nodes reached by the axis in turn.
- See Also:
-
iterateAxis
Return an iteration over the nodes reached by the given axis from this node- Specified by:
iterateAxis
in interfaceNodeInfo
- Parameters:
axisNumber
- the axis to be searched, e.g. Axis.CHILD or Axis.ANCESTORnodeTest
- A pattern to be matched by the returned nodes- Returns:
- a SequenceIterator that scans the nodes reached by the axis in turn.
- See Also:
-
getAttributeValue
Get the value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
fingerprint
- The fingerprint of the attribute name- Returns:
- the attribute value if it exists or null if not
-
getAttributeValue
Get the string value of a given attribute of this node- Specified by:
getAttributeValue
in interfaceNodeInfo
- Parameters:
uri
- the namespace URI of the attribute name. Supply the empty string for an attribute that is in no namespacelocal
- 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
Get the root node of this tree (not necessarily a document node). Always returns this node in the case of an Orphan node. -
getDocumentRoot
Get the root (document) node- Specified by:
getDocumentRoot
in interfaceNodeInfo
- Returns:
- the DocumentInfo representing the containing document, or null if the node is not part of a document. Always null for an Orphan node.
-
hasChildNodes
public boolean hasChildNodes()Determine whether the node has any children.- Specified by:
hasChildNodes
in interfaceNodeInfo
- Returns:
- false - an orphan node never has any children
-
generateId
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 interfaceNodeInfo
- Parameters:
buffer
- a buffer, into which will be placed a string that uniquely identifies this node, within this document. The calling code prepends information to make the result unique across all documents.
-
getDocumentNumber
public long getDocumentNumber()Get the document number of the document containing this node. For a free-standing orphan node, just return the hashcode.- Specified by:
getDocumentNumber
in interfaceNodeInfo
- Returns:
- the document number of the document containing this node
-
copy
Copy this node to a given outputter (deep copy)- Specified by:
copy
in interfaceNodeInfo
- 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
-
getDeclaredNamespaces
Get all namespace undeclarations and undeclarations defined on this element.- Specified by:
getDeclaredNamespaces
in interfaceNodeInfo
- 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 -
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 -
insertChildren
Insert copies of a sequence of nodes as children of this node.This method takes no action unless the target node is a document node or element node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes will be copied to form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed.
- Specified by:
insertChildren
in interfaceMutableNodeInfo
- Parameters:
source
- the nodes to be insertedatStart
- true if the new nodes are to be inserted before existing children; false if they areinherit
- true if the insert nodes are to inherit the namespaces of their new parent; false if such namespaces are to be undeclared
-
insertSiblings
Insert copies of a sequence of nodes as siblings of this node.This method takes no action unless the target node is an element, text node, comment, or processing instruction, and one that has a parent node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.
The supplied nodes must use the same data model implementation as the tree into which they will be inserted.
- Specified by:
insertSiblings
in interfaceMutableNodeInfo
- Parameters:
source
- the nodes to be insertedbefore
- true if the new nodes are to be inserted before the target node; false if they areinherit
- true if the insert nodes are to inherit the namespaces of their new parent; false if such namespaces are to be undeclared
-
removeAttribute
Remove an attribute from this element nodeIf this node is not an element, or if it has no attribute with the specified name, this method takes no action.
The attribute node itself is not modified in any way.
- Specified by:
removeAttribute
in interfaceMutableNodeInfo
- Parameters:
attribute
- the attribute node to be removed
-
addAttribute
Add an attribute to this element node.If this node is not an element, or if the supplied node is not an attribute, the method takes no action. If the element already has an attribute with this name, the existing attribute is replaced.
- Specified by:
addAttribute
in interfaceMutableNodeInfo
- Parameters:
nameCode
- the name of the new attributeattType
- the type annotation of the new attributevalue
- the string value of the new attributeproperties
- properties including IS_ID and IS_IDREF properties
-
delete
public void delete()Delete this node (that is, detach it from its parent).If this node has preceding and following siblings that are both text nodes, the two text nodes will be joined into a single text node (the identity of this node with respect to its predecessors is undefined).
- Specified by:
delete
in interfaceMutableNodeInfo
-
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
- Returns:
- true if this node has been deleted
-
replace
Replace this node with a given sequence of nodes- Specified by:
replace
in interfaceMutableNodeInfo
- Parameters:
replacement
- the replacement nodesinherit
- true if the replacement nodes are to inherit the namespaces of their new parent; false if such namespaces are to be undeclared- Throws:
IllegalArgumentException
- if any of the replacement nodes is of the wrong kind. When replacing a child node, the replacement nodes must all be elements, text, comment, or PI nodes; when replacing an attribute, the replacement nodes must all be attributes.IllegalStateException
- if this node is deleted or if it has no parent node.
-
replaceStringValue
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.- Specified by:
replaceStringValue
in interfaceMutableNodeInfo
- Parameters:
stringValue
- the new string value
-
rename
Rename this node.This call has no effect if applied to a nameless node, such as a text node or comment.
If necessary, a new namespace binding will be added to the target element, or to the element parent of the target attribute
- Specified by:
rename
in interfaceMutableNodeInfo
- Parameters:
newNameCode
- the namecode of the new name in the name pool- Throws:
IllegalArgumentException
- if the new name code is not present in the name pool, or if it has a (prefix, uri) pair in which the prefix is the same as that of an existing in-scope namespace binding and the uri is different from that namespace binding.
-
addNamespace
Add a namespace binding (that is, a namespace node) to this element. This call has no effect if applied to a node other than an element.- Specified by:
addNamespace
in interfaceMutableNodeInfo
- Parameters:
nscode
- The namespace code representing the (prefix, uri) pair of the namespace binding to be added. If the target element already has a namespace binding with this (prefix, uri) pair, the call has no effect. If the target element currently has a namespace binding with this prefix and a different URI, an exception is raised.inherit
- If true, the new namespace binding will be inherited by any children of the target element that do not already have a namespace binding for the specified prefix, recursively. If false, the new namespace binding will not be inherited.- Throws:
IllegalArgumentException
- if the namespace code is not present in the namepool, or if the target element already has a namespace binding for this prefix
-
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. (Note: the caller is responsible for updating the set of nodes marked for revalidation)- Specified by:
removeTypeAnnotation
in interfaceMutableNodeInfo
-
newBuilder
Get a Builder suitable for building nodes that can be attached to this document. This implementation always throws an exception: the method should only be called on a document or element node when creating new children.- Specified by:
newBuilder
in interfaceMutableNodeInfo
- Returns:
- a new Builder that constructs nodes using the same object model implementation as this one, suitable for attachment to this tree
-