DeleteSubtree (XmlDoc/XmlNode subroutine) - Revision history

JAL at 22:23, 17 February 2015

2015-02-17T22:23:54Z

← Older revision		Revision as of 22:23, 17 February 2015
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:DeleteSubtree syntax}}		{{Template:XmlDoc/XmlNode:DeleteSubtree syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>nr</th>		<tr><th>nr</th>
	<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>		<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>

	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist. The head of the nodelist is the "top" node of the subtree to ~~delete~~. An optional argument, its default is a period (<tt>.</tt>), that is, the node referenced by the method object (<var class="term">nr</var>).		<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist. The node that is the head of the nodelist is the "top" node of the subtree to be deleted. Any other nodes in the nodelist are ignored.
	<p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>		<p>
			This is an optional argument, and its default is a period (<tt>.</tt>), that is, the node referenced by the method object (<var class="term">nr</var>).</p>
			<p>
			Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>Any pointers (as <var>XmlNode</var>s or in <var>XmlNodelist</var>s) to any of ~~the deleted nodes~~ will subsequently evaluate to <var>Null</var>.		<li>Any pointers (as <var>XmlNode</var>s or in <var>XmlNodelist</var>s) to the deleted node or any of its descendants will subsequently evaluate to <var>Null</var>.</li>
	<li><var>DeleteSubtree</var> may not be used if the preceding and following siblings of the top of the subtree are both <var>Text</var> nodes, unless the <var>[[AdjacentText (XmlDoc property)\|AdjacentText]]</var> property setting is <code>Combine</code>.
	<li>If the result of the <var class="term">xpath</var> argument expression is empty, <var>DeleteSubtree</var> returns without deleting any nodes.		<li><var>DeleteSubtree</var> may not be used if the preceding and following siblings of the top of the subtree are both <var>Text</var> nodes, unless the <var>[[AdjacentText (XmlDoc property)\|AdjacentText]]</var> property setting is <code>Combine</code>.</li>

			<li>If the result of the <var class="term">xpath</var> argument expression is empty, <var>DeleteSubtree</var> returns without deleting any nodes.</li>

	<li>If the top node in the deleted subtree was originally added to the document by an <var>[[AddAttribute_(XmlNode_function)\|AddAttribute]]</var> method with a <var class="term">uri</var> argument which created a namespace declaration, <var>DeleteSubtree</var> applied to that node does not remove the namespace declaration.		<li>If the top node in the deleted subtree was originally added to the document by an <var>[[AddAttribute_(XmlNode_function)\|AddAttribute]]</var> method with a <var class="term">uri</var> argument which created a namespace declaration, <var>DeleteSubtree</var> applied to that node does not remove the namespace declaration.
	For example:		For example:
Line 30:		Line 38:
	<p class="output">Before AddAttribute/Delete: <x/>		<p class="output">Before AddAttribute/Delete: <x/>
	After AddAttribute/Delete: <x xmlns:p="ftp:a"/>		After AddAttribute/Delete: <x xmlns:p="ftp:a"/>
	</p>		</p></li>

	<li>In the following circumstances, <var>DeleteSubtree</var> does not completely "undo" a preceding <var>[[AddSubtree_(XmlDoc/XmlNode_function)\|AddSubtree]]</var> or <var>[[InsertSubtreeBefore_(XmlNode_function)\|InsertSubtreeBefore]]</var> method:		<li>In the following circumstances, <var>DeleteSubtree</var> does not completely "undo" a preceding <var>[[AddSubtree_(XmlDoc/XmlNode_function)\|AddSubtree]]</var> or <var>[[InsertSubtreeBefore_(XmlNode_function)\|InsertSubtreeBefore]]</var> method:
	<ol>		<ol>
	<li>The top node in the deleted subtree is originally added to the document by an <var>AddAttribute</var> method and has a name prefix.		<li>The top node in the deleted subtree is originally added to the document by an <var>AddAttribute</var> method and has a name prefix.</li>
	<li>This attribute node is copied, by <var>AddSubtree</var> or <var>InsertSubtreeBefore</var>, to a target where the attribute prefix is not in scope.
	<li>The attribute node is removed by <var>DeleteSubtree</var>, but the namespace declaration for the prefix remains.		<li>This attribute node is copied, by <var>AddSubtree</var> or <var>InsertSubtreeBefore</var>, to a target where the attribute prefix is not in scope.</li>

			<li>The attribute node is removed by <var>DeleteSubtree</var>, but the namespace declaration for the prefix remains.</li>
	</ol>		</ol>
	For example:		For example:
Line 55:		Line 66:
	After AddSubtree/Delete:		After AddSubtree/Delete:
	<x><x1 xmlns:p="ftp:a" p:a="v"/><x2 xmlns:p="ftp:a"/></x>		<x><x1 xmlns:p="ftp:a" p:a="v"/><x2 xmlns:p="ftp:a"/></x>
	</p>		</p></li>

	<li>As discussed in the <var>XmlDoc</var> API [[XmlDoc API#Updating\|section on updating]], the items deleted by <var>DeleteSubtree</var> are not available for re-use by later Add, Insert, etc. methods, so <var>DeleteSubtree</var> does not affect the restriction of 16M items in an <var>XmlDoc</var>.		<li>As discussed in the <var>XmlDoc</var> API [[XmlDoc API#Updating\|section on updating]], the items deleted by <var>DeleteSubtree</var> are not available for re-use by later Add, Insert, etc. methods, so <var>DeleteSubtree</var> does not affect the restriction of 16M items in an <var>XmlDoc</var>.</li>
	</ul>		</ul>

Dme: /* Usage notes */

2014-07-20T13:30:37Z

Usage notes

← Older revision		Revision as of 13:30, 20 July 2014
Line 38:		Line 38:
	</ol>		</ol>
	For example:		For example:
	<p class="code">%d = ~~New~~		<p class="code">%d = new
	%n = %d:~~AddElement~~('x')		%n = %d:addElement('x')
	%n2 = %n:~~AddElement~~('x1')		%n2 = %n:addElement('x1')
	%n = %n:~~AddElement~~('x2')		%n = %n:addElement('x2')
	%n2 = %n2:~~AddAttribute~~('p:a', 'v', 'ftp:a')		%n2 = %n2:addAttribute('p:a', 'v', 'ftp:a')
	~~Print~~ 'Before AddSubtree/Delete:'		print 'Before AddSubtree/Delete:'
	~~Print~~ %d:Serial(, 'EBCDIC')		print %d:Serial(, 'EBCDIC')
	%n2 = %n:~~AddSubtree~~(%n2)		%n2 = %n:addSubtree(%n2)
	%n2:<var>~~DeleteSubtree~~</var>		%n2:<var>deleteSubtree</var>
	~~Print~~ 'After AddSubtree/Delete:'		print 'After AddSubtree/Delete:'
	~~Print~~ %d:Serial(, 'EBCDIC')		print %d:Serial(, 'EBCDIC')
	</p>		</p>
	This results in:		This results in:

JAL: /* Request-cancellation errors */

2014-03-03T17:23:01Z

Request-cancellation errors

← Older revision		Revision as of 17:23, 3 March 2014
Line 66:		Line 66:

	==Request-cancellation errors==		==Request-cancellation errors==
			This list is not exhaustive: it does <i>not</i> include all the errors that are request cancelling.
	<ul>		<ul>
	<li>The <var class="term">xpath</var> value is invalid.		<li>The <var class="term">xpath</var> value is invalid.

Dme: /* Usage notes */

2014-02-20T20:13:16Z

Usage notes

← Older revision		Revision as of 20:13, 20 February 2014
Line 57:		Line 57:
	</p>		</p>

	<li>As discussed in the <var>XmlDoc</var> API [[#Updating\|section on updating]], the items deleted by <var>DeleteSubtree</var> are not available for re-use by later Add, Insert, etc. methods, so <var>DeleteSubtree</var> does not affect the restriction of 16M items in an <var>XmlDoc</var>.		<li>As discussed in the <var>XmlDoc</var> API [[XmlDoc API#Updating\|section on updating]], the items deleted by <var>DeleteSubtree</var> are not available for re-use by later Add, Insert, etc. methods, so <var>DeleteSubtree</var> does not affect the restriction of 16M items in an <var>XmlDoc</var>.
	</ul>		</ul>

Dme: /* Usage notes */

2014-02-20T20:10:32Z

Usage notes

← Older revision		Revision as of 20:10, 20 February 2014
Line 57:		Line 57:
	</p>		</p>

	<li>As discussed in the <var>XmlDoc</var> API [[#Updating\|section on updating]], the items deleted by <var>DeleteSubtree</var> are not available for re-use by later Add, Insert, etc. methods, ~~and~~ <var>DeleteSubtree</var> does not affect the restriction of 16M items in an <var>XmlDoc</var>.		<li>As discussed in the <var>XmlDoc</var> API [[#Updating\|section on updating]], the items deleted by <var>DeleteSubtree</var> are not available for re-use by later Add, Insert, etc. methods, so <var>DeleteSubtree</var> does not affect the restriction of 16M items in an <var>XmlDoc</var>.
	</ul>		</ul>

Dme: /* Usage notes */

2014-02-20T20:10:00Z

Usage notes

← Older revision		Revision as of 20:10, 20 February 2014
Line 56:		Line 56:
	<x><x1 xmlns:p="ftp:a" p:a="v"/><x2 xmlns:p="ftp:a"/></x>		<x><x1 xmlns:p="ftp:a" p:a="v"/><x2 xmlns:p="ftp:a"/></x>
	</p>		</p>

			<li>As discussed in the <var>XmlDoc</var> API [[#Updating\|section on updating]], the items deleted by <var>DeleteSubtree</var> are not available for re-use by later Add, Insert, etc. methods, and <var>DeleteSubtree</var> does not affect the restriction of 16M items in an <var>XmlDoc</var>.
	</ul>		</ul>

JAL2 at 21:36, 31 May 2011

2011-05-31T21:36:34Z

← Older revision		Revision as of 21:36, 31 May 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>nr</th>		<tr><th>nr</th>
	<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">~~XPath~~</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>		<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>
	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist. The head of the nodelist is the "top" node of the subtree to delete. An optional argument, its default is a period (.), that is, the node referenced by the method object (<var class="term">nr</var>).		<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist. The head of the nodelist is the "top" node of the subtree to delete. An optional argument, its default is a period (<tt>.</tt>), that is, the node referenced by the method object (<var class="term">nr</var>).
	<p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>		<p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>
	</table>		</table>
Line 17:		Line 17:
	<li>Any pointers (as <var>XmlNode</var>s or in <var>XmlNodelist</var>s) to any of the deleted nodes will subsequently evaluate to <var>Null</var>.		<li>Any pointers (as <var>XmlNode</var>s or in <var>XmlNodelist</var>s) to any of the deleted nodes will subsequently evaluate to <var>Null</var>.
	<li><var>DeleteSubtree</var> may not be used if the preceding and following siblings of the top of the subtree are both <var>Text</var> nodes, unless the <var>[[AdjacentText (XmlDoc property)\|AdjacentText]]</var> property setting is <code>Combine</code>.		<li><var>DeleteSubtree</var> may not be used if the preceding and following siblings of the top of the subtree are both <var>Text</var> nodes, unless the <var>[[AdjacentText (XmlDoc property)\|AdjacentText]]</var> property setting is <code>Combine</code>.
	<li>If the result of the argument ~~XPath~~ expression is empty, <var>DeleteSubtree</var> returns without deleting any nodes.		<li>If the result of the <var class="term">xpath</var> argument expression is empty, <var>DeleteSubtree</var> returns without deleting any nodes.
	<li>If the top node in the deleted subtree was originally added to the document by an <var>[[AddAttribute_(XmlNode_function)\|AddAttribute]]</var> method with a <var class="term">~~URI~~</var> argument which created a namespace declaration, <var>DeleteSubtree</var> applied to that node does not remove the namespace declaration.		<li>If the top node in the deleted subtree was originally added to the document by an <var>[[AddAttribute_(XmlNode_function)\|AddAttribute]]</var> method with a <var class="term">uri</var> argument which created a namespace declaration, <var>DeleteSubtree</var> applied to that node does not remove the namespace declaration.
	For example:		For example:
	<p class="code">%d = new		<p class="code">%d = new
Line 31:		Line 31:
	After AddAttribute/Delete: <x xmlns:p="ftp:a"/>		After AddAttribute/Delete: <x xmlns:p="ftp:a"/>
	</p>		</p>
	<li>In the following circumstances, <var>DeleteSubtree</var> does not completely "undo" a preceding <var>[[AddSubtree_(XmlDoc/XmlNode_function)\|~~addSubtree~~]]</var> or <var>[[InsertSubtreeBefore_(XmlNode_function)\|~~insertSubtreeBefore~~]]</var> method:		<li>In the following circumstances, <var>DeleteSubtree</var> does not completely "undo" a preceding <var>[[AddSubtree_(XmlDoc/XmlNode_function)\|AddSubtree]]</var> or <var>[[InsertSubtreeBefore_(XmlNode_function)\|InsertSubtreeBefore]]</var> method:
	<ol>		<ol>
	<li>The top node in the deleted subtree is originally added to the document by an <var>~~[[AddAttribute_(XmlNode_function)\|~~AddAttribute]]</var> method and has a name prefix.		<li>The top node in the deleted subtree is originally added to the document by an <var>AddAttribute</var> method and has a name prefix.
	<li>This attribute node is copied, by <var>AddSubtree</var> or <var>InsertSubtreeBefore</var>, to a target where the attribute prefix is not in scope.		<li>This attribute node is copied, by <var>AddSubtree</var> or <var>InsertSubtreeBefore</var>, to a target where the attribute prefix is not in scope.
	<li>The attribute node is removed by <var>DeleteSubtree</var>, but the namespace declaration for the prefix remains.		<li>The attribute node is removed by <var>DeleteSubtree</var>, but the namespace declaration for the prefix remains.
Line 63:		Line 63:
	</p>		</p>

	==Request-~~Cancellation Errors~~==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">xpath</var> is invalid.		<li>The <var class="term">xpath</var> value is invalid.
	<li>Head of result of <var class="term">xpath</var> is the <var>Root</var> node.		<li>Head of result of <var class="term">xpath</var> is the <var>Root</var> node.
	<li>Head of result of <var class="term">xpath</var> is a node whose left and right siblings are <var>Text</var> nodes, and the <var>[[AdjacentText_(XmlDoc_property)\|AdjacentText]]</var> property setting is <code>Disallow</code>.		<li>Head of result of <var class="term">xpath</var> is a node whose left and right siblings are <var>Text</var> nodes, and the <var>[[AdjacentText_(XmlDoc_property)\|AdjacentText]]</var> property setting is <code>Disallow</code>.

JAL2 at 23:49, 24 May 2011

2011-05-24T23:49:58Z

← Older revision		Revision as of 23:49, 24 May 2011
Line 17:		Line 17:
	<li>Any pointers (as <var>XmlNode</var>s or in <var>XmlNodelist</var>s) to any of the deleted nodes will subsequently evaluate to <var>Null</var>.		<li>Any pointers (as <var>XmlNode</var>s or in <var>XmlNodelist</var>s) to any of the deleted nodes will subsequently evaluate to <var>Null</var>.
	<li><var>DeleteSubtree</var> may not be used if the preceding and following siblings of the top of the subtree are both <var>Text</var> nodes, unless the <var>[[AdjacentText (XmlDoc property)\|AdjacentText]]</var> property setting is <code>Combine</code>.		<li><var>DeleteSubtree</var> may not be used if the preceding and following siblings of the top of the subtree are both <var>Text</var> nodes, unless the <var>[[AdjacentText (XmlDoc property)\|AdjacentText]]</var> property setting is <code>Combine</code>.
	<li>If the result of the argument ~~<var class="term">~~XPath~~</var>~~ expression is empty, <var>DeleteSubtree</var> returns without deleting any nodes.		<li>If the result of the argument XPath expression is empty, <var>DeleteSubtree</var> returns without deleting any nodes.
	<li>If the top node in the deleted subtree was originally added to the document by an <var>[[AddAttribute_(XmlNode_function)\|AddAttribute]]</var> method with a <var class="term">URI</var> argument which created a namespace declaration, <var>DeleteSubtree</var> applied to that node does not remove the namespace declaration.		<li>If the top node in the deleted subtree was originally added to the document by an <var>[[AddAttribute_(XmlNode_function)\|AddAttribute]]</var> method with a <var class="term">URI</var> argument which created a namespace declaration, <var>DeleteSubtree</var> applied to that node does not remove the namespace declaration.
	For example:		For example:
Line 59:		Line 59:

	==Example==		==Example==
	~~<ol>~~		The following example deletes the first <code>employee</code> child of the top-level <var>Element</var> of the <var>XmlDoc</var>:
	~~<li>Tthe~~ following example deletes the first <code>employee</code> child of the top-level <var>Element</var> of the <var>XmlDoc</var>:
	<p class="code">%doc:deleteSubtree('/*/employee')		<p class="code">%doc:deleteSubtree('/*/employee')
	</p~~></ol~~>		</p>

	==Request-Cancellation Errors==		==Request-Cancellation Errors==
	<ul>		<ul>
	<li><var class="term">~~XPath~~</var> is invalid.		<li><var class="term">xpath</var> is invalid.
	<li>Head of result of <var class="term">~~XPath~~</var> is the <var>Root</var> node.		<li>Head of result of <var class="term">xpath</var> is the <var>Root</var> node.
	<li>Head of result of <var class="term">~~XPath~~</var> is a node whose left and right siblings are <var>Text</var> nodes, and the <var>[[AdjacentText_(XmlDoc_property)\|AdjacentText]]</var> property setting is <code>Disallow</code>.		<li>Head of result of <var class="term">xpath</var> is a node whose left and right siblings are <var>Text</var> nodes, and the <var>[[AdjacentText_(XmlDoc_property)\|AdjacentText]]</var> property setting is <code>Disallow</code>.
	<li><var>Element</var> or <var>Attribute</var> within subtree has a prefix.		<li><var>Element</var> or <var>Attribute</var> within subtree has a prefix.
	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.
Line 75:		Line 74:
	==See also==		==See also==
	<ul>		<ul>
	<li>For more information about using XPath expressions, see [[XPath]].		<li>For more information about using XPath expressions, see [[XPath\|"XPath"]].
	</ul>		</ul>
	{{Template:XmlDoc/XmlNode:DeleteSubtree footer}}		{{Template:XmlDoc/XmlNode:DeleteSubtree footer}}

JALWiccan: 1 revision

2011-05-24T17:26:03Z

1 revision

← Older revision	Revision as of 17:26, 24 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-24T17:26:02Z

1 revision

← Older revision		Revision as of 17:26, 24 May 2011
Line 10:		Line 10:
	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist. The head of the nodelist is the "top" node of the subtree to delete. An optional argument, its default is a period (.), that is, the node referenced by the method object (<var class="term">nr</var>).		<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|XPath expression]] that results in a nodelist. The head of the nodelist is the "top" node of the subtree to delete. An optional argument, its default is a period (.), that is, the node referenced by the method object (<var class="term">nr</var>).
	<p>Prior to <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>		<p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>
	</table>		</table>