net.sf.saxon.om
public final class Orphan extends Object implements MutableNodeInfo, FingerprintedNode
Constructor Summary | |
---|---|
Orphan(Configuration config)
Create an Orphan node |
Method Summary | |
---|---|
void | addAttribute(int nameCode, int typeCode, CharSequence value, int properties)
Add an attribute to this element node.
|
void | addNamespace(int nscode, boolean inherit)
Add a namespace binding (that is, a namespace node) to this element. |
Value | atomize()
Get the typed value. |
int | compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
void | copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter (deep copy) |
void | delete()
Delete this node (that is, detach it from its parent).
|
boolean | equals(Object other)
The equals() method compares nodes for identity. |
void | generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node.
|
String | getAttributeValue(int fingerprint)
Get the value of a given attribute of this node |
String | getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained
in the node. |
int | getColumnNumber()
Get column number |
Configuration | getConfiguration()
Get the configuration |
int[] | getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
String | getDisplayName()
Get the display name of this node. |
long | getDocumentNumber()
Get the document number of the document containing this node. |
DocumentInfo | getDocumentRoot()
Get the root (document) node |
int | getFingerprint()
Get fingerprint. |
int | getLineNumber()
Get line number |
String | getLocalPart()
Get the local part of the name of this node. |
int | getNameCode()
Get name code. |
NamePool | getNamePool()
Get the name pool |
int | getNodeKind()
Return the kind of node. |
NodeInfo | getParent()
Get the NodeInfo object representing the parent of this node |
String | getPrefix()
Get the prefix of the name of the node. |
NodeInfo | getRoot()
Get the root node of this tree (not necessarily a document node).
|
String | getStringValue()
Return the string value of the node. |
CharSequence | getStringValueCS()
Get the value of the item as a CharSequence. |
String | getSystemId()
Get the System ID for the node. |
int | getTypeAnnotation()
Get the type annotation |
SequenceIterator | getTypedValue()
Get the typed value of the node |
String | getURI()
Get the URI part of the name of this node. |
boolean | hasChildNodes()
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 | isDeleted()
Test whether this MutableNodeInfo object represents a node that has been deleted.
|
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
|
boolean | isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node. |
AxisIterator | iterateAxis(byte axisNumber)
Return an iteration over the nodes reached by the given axis from this node |
AxisIterator | iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iteration over the nodes reached by the given axis from this node |
Builder | newBuilder()
Get a Builder suitable for building nodes that can be attached to this document.
|
void | removeAttribute(NodeInfo attribute)
Remove an attribute from this element node
If 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. |
void | removeTypeAnnotation()
Remove type information from this node (and its ancestors, recursively).
|
void | rename(int newNameCode)
Rename this node.
|
void | replace(NodeInfo[] replacement, boolean inherit)
Replace this node with a given sequence of nodes |
void | replaceStringValue(CharSequence stringValue)
Replace the string-value of this node. |
void | setIsId(boolean id)
Set the isId property |
void | setIsIdref(boolean idref)
Set the isIdref property |
void | setNameCode(int nameCode)
Set the name of the node |
void | setNodeKind(short kind)
Set the node kind |
void | setStringValue(CharSequence stringValue)
Set the string value of the node |
void | setSystemId(String systemId)
Set the base URI of the node |
void | setTypeAnnotation(int typeAnnotation)
Set the type annotation of the node |
Parameters: config the Saxon configuration
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.
Parameters: nameCode the name of the new attribute typeCode the type annotation of the new attribute value the string value of the new attribute properties properties including IS_ID and IS_IDREF properties
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
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
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())
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).
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.
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.
Parameters: fingerprint The fingerprint of the attribute name
Returns: the attribute value if it exists or null if not
Returns: the column number of the node in its original source document; or -1 if not available
Returns: the Saxon configuration object
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.
Returns: The display name of this node. For a node with no name, return an empty string.
Returns: the DocumentInfo representing the containing document, or null if the node is not part of a document. Always null for an Orphan node.
Returns: the line number of the node in its original source document; or -1 if not available
Returns: the local part of the name. For an unnamed node, returns "".
See Also: allocate
Returns: one of the values Type.ELEMENT, Type.TEXT, Type.ATTRIBUTE, etc.
Returns: null - an Orphan has no parent.
Returns: The prefix of the name of the node.
Returns: the string value of the node
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.
Returns: an iterator over the items making up the typed value
Returns: The URI of the namespace of this node. For an unnamed node, return null. For a node with an empty prefix, return an empty string.
Returns: false - an orphan node never has any children
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.
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.
Parameters: source the nodes to be inserted atStart true if the new nodes are to be inserted before existing children; false if they are inherit true if the insert nodes are to inherit the namespaces of their new parent; false if such namespaces are to be undeclared
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.
Parameters: source the nodes to be inserted before true if the new nodes are to be inserted before the target node; false if they are inherit true if the insert nodes are to inherit the namespaces of their new parent; false if such namespaces are to be undeclared
Returns: true if this node has been deleted
Returns: true if the node is an ID
Returns: true if the node is an IDREF or IDREFS element or attribute
Returns: true if the node has the is-nilled property
Returns: true if this Node object and the supplied Node object represent the same node in the tree.
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.
Parameters: axisNumber the axis to be searched, e.g. Axis.CHILD or Axis.ANCESTOR nodeTest A pattern to be matched by the returned nodes
Returns: a SequenceIterator that scans the nodes reached by the axis in turn.
If 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.
Parameters: attribute the attribute node to be removed
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
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.
Parameters: replacement the replacement nodes inherit 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.
Parameters: stringValue the new string value
Parameters: id the isId property
Parameters: idref the isIdref property
Parameters: nameCode the integer code representing the name of the node in the NamePool
Parameters: stringValue the string value of the node
Parameters: systemId the base URI of the node
Parameters: typeAnnotation the type annotation, and integer code representing the fingerprint of the type name