SubsetNew (NamedArraylist function) - Revision history

Dme: /* Examples */

2012-08-11T21:51:04Z

Examples

@@ Line 24: / Line 24: @@
 ==Examples==
-In the following fragment, a <var>SubsetNew</var> call is applied to a collection of objects of the <code>staff</code> class that is defined in the request in the <var>NamedArraylist</var> <var>FindNextItem</var> [[FindNextItem (GenericNamedArraylist function)#Examples|"Examples"]] section:
+<ol>
 <p class="code">%old is namedArraylist of object staff
 %old = new
@@ Line 44: / Line 45: @@
 Jud Brown
 </p>
+<li>In the following fragment, two nearly identical <var>SubsetNew</var> calls are used.  The first uses a <var>SelectionCriterion</var> whose first argument (<code>this</code>) is a <var>String</var> valued function, and so EBCDIC comparisons are used. The second uses a <var>SelectionCriterion</var> whose first argument (<code>this</code>) is a <var>Unicode</var> valued function, and so Unicode comparisons are used.
 ==See also==

JAL2 at 22:01, 7 August 2012

2012-08-07T22:01:32Z

← Older revision		Revision as of 22:01, 7 August 2012
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:NamedArraylist:SubsetNew syntax}}		{{Template:NamedArraylist:SubsetNew syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outNal</th>		<tr><th>%outNal</th>
	<td>A <var>NamedArraylist</var> variable of the same type as the method <var>NamedArraylist</var> (<var class="term">~~Nal~~</var>) to contain the items that are located by the search. If <var class="term">outNal</var> is not empty, its contents are discarded before it is populated by the items returned from <var>SubsetNew</var>. </td></tr>		<td>A <var>NamedArraylist</var> variable of the same type as the method <var>NamedArraylist</var> (<var class="term">nal</var>) to contain the items that are located by the search. If <var class="term">outNal</var> is not empty, its contents are discarded before it is populated by the items returned from <var>SubsetNew</var>. </td></tr>

	<tr><th>nal</th>		<tr><th>nal</th>
	<td>A <var>NamedArraylist</var> object. </td></tr>		<td>A <var>NamedArraylist</var> object. </td></tr>

	<tr><th>selectionCriterion</th>		<tr><th>selectionCriterion</th>
	<td>A <var>SelectionCriterion</var> object, which is a relational expression that is applied to a <var class="term">nal</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.		<td>A <var>SelectionCriterion</var> object, which is a relational expression that is applied to a <var class="term">nal</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.
	<p>For example, <code>GT(this, -11)</code> is the criterion <code>this > -11</code>, where <var>this</var> is an identity function value that simply returns the item's value. The items that satisfy this expression populate the <var>NamedArraylist</var> that <var>SubsetNew</var> returns.</p>		<p>For example, <code>GT(this, -11)</code> is the criterion <code>this > -11</code>, where <var>this</var> is an identity function value that simply returns the item's value. The items that satisfy this expression populate the <var>NamedArraylist</var> that <var>SubsetNew</var> returns.</p>
	<p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value. This is described further in [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|"Specifying a SelectionCriterion's parameters"]].</p></td></tr>		<p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value. This is described further in [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|"Specifying a SelectionCriterion's parameters"]].</p></td></tr>
			</table>

	~~</table>~~
	==Usage notes==		==Usage notes==
	<ul><li><var>SubsetNew</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.		<ul><li><var>SubsetNew</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.
Line 21:		Line 24:

	==Examples==		==Examples==
	~~<ol><li>~~In the following fragment, a <var>SubsetNew</var> call is applied to a collection of objects of the <code>staff</code> class that is defined in the request in the <var>NamedArraylist</var> <var>FindNextItem</var> [[FindNextItem (GenericNamedArraylist function)#Examples\|"Examples"]] section:		In the following fragment, a <var>SubsetNew</var> call is applied to a collection of objects of the <code>staff</code> class that is defined in the request in the <var>NamedArraylist</var> <var>FindNextItem</var> [[FindNextItem (GenericNamedArraylist function)#Examples\|"Examples"]] section:
	<p class="code">%old is namedArraylist of object staff		<p class="code">%old is namedArraylist of object staff
	%old = new		%old = new
Line 41:		Line 44:
	2 Jud Brown		2 Jud Brown
	</p>		</p>
	~~</ol>~~

	==See also==		==See also==

Dme: /* See also */

2012-08-03T16:40:03Z

JALWiccan: 1 revision

2011-05-04T17:45:58Z

1 revision

← Older revision	Revision as of 17:45, 4 May 2011
(No difference)

Dme at 17:45, 4 May 2011

2011-05-04T17:45:57Z

← Older revision		Revision as of 17:45, 4 May 2011
Line 17:		Line 17:
	</table>		</table>
	==Usage notes==		==Usage notes==
	<ul><li><var>SubsetNew</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6 and later.		<ul><li><var>SubsetNew</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.
	</ul>		</ul>

Dme at 17:52, 3 May 2011

2011-05-03T17:52:49Z

← Older revision		Revision as of 17:52, 3 May 2011
Line 12:		Line 12:
	<tr><th>selectionCriterion</th>		<tr><th>selectionCriterion</th>
	<td>A <var>SelectionCriterion</var> object, which is a relational expression that is applied to a <var class="term">nal</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.		<td>A <var>SelectionCriterion</var> object, which is a relational expression that is applied to a <var class="term">nal</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.
	<p>For example, <code>GT(this, -11)</code> is the criterion <code>this > -11</code>, where <~~code~~>this</~~code~~> is an identity function that simply returns the item's value. The items that satisfy this expression populate the <var>NamedArraylist</var> that <var>SubsetNew</var> returns.</p>		<p>For example, <code>GT(this, -11)</code> is the criterion <code>this > -11</code>, where <var>this</var> is an identity function value that simply returns the item's value. The items that satisfy this expression populate the <var>NamedArraylist</var> that <var>SubsetNew</var> returns.</p>
	<p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value. This is described further in [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|"Specifying a SelectionCriterion's parameters"]].</p></td></tr>		<p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value. This is described further in [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|"Specifying a SelectionCriterion's parameters"]].</p></td></tr>

Goff: match syntax table to syntax template, tags and edits

2011-03-11T06:17:38Z

match syntax table to syntax template, tags and edits

← Older revision		Revision as of 06:17, 11 March 2011
Line 1:		Line 1:
	{{Template:NamedArraylist:SubsetNew subtitle}}		{{Template:NamedArraylist:SubsetNew subtitle}}
			<var>SubsetNew</var> searches the entire <var>NamedArraylist</var> to find and return all items that match a specified criterion. The criterion is supplied by the <var>[[SelectionCriterion class\|SelectionCriterion]]</var> object that is the required <var>SubsetNew</var> parameter. If no item satisfies the criterion, <var>SubsetNew</var> returns an empty <var>NamedArraylist</var>.

	~~This function searches the entire NamedArraylist to find and return~~
	~~all items that match a specified criterion.~~
	~~The criterion is supplied by the [[SelectionCriterion class\|SelectionCriterion]] object.~~
	~~that is the required SubsetNew parameter.~~
	~~If no item satisfies the criterion, SubsetNew returns an empty NamedArraylist.~~

	~~SubsetNew is available in ''Sirius Mods'' version 7.6 and later.~~
	==Syntax==		==Syntax==
	{{Template:NamedArraylist:SubsetNew syntax}}		{{Template:NamedArraylist:SubsetNew syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~namraylNew~~</th>		<tr><th>%outNal</th>
	<td>A NamedArraylist variable of the same type as the method NamedArraylist (~~''%namrayl''~~) to contain the items that are located by the search. If ~~''%namraylNew''~~ is not empty, its contents are discarded before it is populated by the ~~return~~ items from SubsetNew. </td></tr>		<td>A <var>NamedArraylist</var> variable of the same type as the method <var>NamedArraylist</var> (<var class="term">Nal</var>) to contain the items that are located by the search. If <var class="term">outNal</var> is not empty, its contents are discarded before it is populated by the items returned from <var>SubsetNew</var>. </td></tr>
	<tr><th>~~%namrayl~~</th>		<tr><th>nal</th>
	<td>A NamedArraylist object. </td></tr>		<td>A <var>NamedArraylist</var> object. </td></tr>
	<tr><th>~~criterion~~</th>		<tr><th>selectionCriterion</th>
	<td>A SelectionCriterion object, which is a relational expression that is applied to a ~~''%namrayl''~~ item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.		<td>A <var>SelectionCriterion</var> object, which is a relational expression that is applied to a <var class="term">nal</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.
			<p>For example, <code>GT(this, -11)</code> is the criterion <code>this > -11</code>, where <code>this</code> is an identity function that simply returns the item's value. The items that satisfy this expression populate the <var>NamedArraylist</var> that <var>SubsetNew</var> returns.</p>
	For example, <tt>GT(this, -11)</tt> is the criterion <tt>this~~</tt> <tt>></tt> <tt~~>-11</tt>, where <tt>this</tt> is an identity function that simply returns the item's value. The items that satisfy this expression populate the NamedArraylist that SubsetNew returns.		<p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the <var class="term">nal</var> declaration and that returns a numeric or string value. This is described further in [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|"Specifying a SelectionCriterion's parameters"]].</p></td></tr>
	The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the ~~''%namrayl''~~ declaration and that returns a numeric or string value. This is described further in [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|"Specifying a SelectionCriterion's parameters"]].</td></tr>

	</table>		</table>
	==Usage notes==		==Usage notes==
	<ul>		<ul><li><var>SubsetNew</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6 and later.
	<li><var>~~[[FindNextItem (NamedArraylist function)\|FindNextItem]]~~</var>
	is ~~similar to~~ <var>~~SubsetNew~~</var> ~~except that it returns just the first matching item~~
	~~it encounters~~.
	</ul>		</ul>

	==Examples==		==Examples==
	<ul>		<ol><li>In the following fragment, a <var>SubsetNew</var> call is applied to a collection of objects of the <code>staff</code> class that is defined in the request in the <var>NamedArraylist</var> <var>FindNextItem</var> [[FindNextItem (GenericNamedArraylist function)#Examples\|"Examples"]] section:
	In the following fragment, a SubsetNew call is applied to a collection
	of objects of the <tt>staff</tt> class that is defined in the
	request in the <var>NamedArraylist</var> <var>FindNextItem</var> [[FindNextItem (GenericNamedArraylist function)#Examples\|"Examples"]] section:
	<p class="code">%old is namedArraylist of object staff		<p class="code">%old is namedArraylist of object staff
	%old = new		%old = new
Line 49:		Line 37:
	%fnd:Print(name, separator=' ')		%fnd:Print(name, separator=' ')
	</p>		</p>

	The result is:		The result is:
	<p class="output">1 Jed Black		<p class="output">1 Jed Black
	2 Jud Brown		2 Jud Brown
	</p>		</p>
			</ol>

			==See also==
			<ul><li><var>[[FindNextItem (NamedArraylist function)\|FindNextItem]]</var> is similar to <var>SubsetNew</var> except that it returns just the first matching item it encounters.
	</ul>		</ul>
	~~==See also==~~
	{{Template:NamedArraylist:SubsetNew footer}}		{{Template:NamedArraylist:SubsetNew footer}}

JAL at 22:53, 2 March 2011

2011-03-02T22:53:36Z

← Older revision		Revision as of 22:53, 2 March 2011
Line 20:		Line 20:

	For example, <tt>GT(this, -11)</tt> is the criterion <tt>this</tt> <tt>></tt> <tt>-11</tt>, where <tt>this</tt> is an identity function that simply returns the item's value. The items that satisfy this expression populate the NamedArraylist that SubsetNew returns.		For example, <tt>GT(this, -11)</tt> is the criterion <tt>this</tt> <tt>></tt> <tt>-11</tt>, where <tt>this</tt> is an identity function that simply returns the item's value. The items that satisfy this expression populate the NamedArraylist that SubsetNew returns.
	The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the ''%namrayl'' declaration and that returns a numeric or string value. This is described further in "[[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]".</td></tr>		The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the ''%namrayl'' declaration and that returns a numeric or string value. This is described further in [[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|"Specifying a SelectionCriterion's parameters"]].</td></tr>

	</table>		</table>
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>[[FindNextItem (NamedArraylist function)\|FindNextItem]]		<li><var>[[FindNextItem (NamedArraylist function)\|FindNextItem]]</var>
	is similar to SubsetNew except that it returns just the first matching item		is similar to <var>SubsetNew</var> except that it returns just the first matching item
	it encounters.		it encounters.
	</ul>		</ul>
Line 33:		Line 33:
	In the following fragment, a SubsetNew call is applied to a collection		In the following fragment, a SubsetNew call is applied to a collection
	of objects of the <tt>staff</tt> class that is defined in the		of objects of the <tt>staff</tt> class that is defined in the
	request in the "[[~~FindPreviousItem~~ (~~NamedArrayArraylist~~ function)#Examples\|~~NamedArrayArraylist FindPreviousItem function example~~]]":		request in the <var>NamedArraylist</var> <var>FindNextItem</var> [[FindNextItem (GenericNamedArraylist function)#Examples\|"Examples"]] section:
	<p class="code">%old is namedArraylist of object staff		<p class="code">%old is namedArraylist of object staff
	%old = new		%old = new

Wiccan: 1 revision

2011-02-08T18:21:38Z

1 revision

← Older revision	Revision as of 18:21, 8 February 2011
(No difference)

Wiccan: 1 revision

2011-02-08T18:21:36Z

1 revision

← Older revision		Revision as of 18:21, 8 February 2011
Line 18:		Line 18:
	<tr><th>criterion</th>		<tr><th>criterion</th>
	<td>A SelectionCriterion object, which is a relational expression that is applied to a ''%namrayl'' item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.		<td>A SelectionCriterion object, which is a relational expression that is applied to a ''%namrayl'' item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.
	~~<p class="code">~~For example, <tt>GT(this, -11)</tt> is the criterion <tt>this</tt> <tt>></tt> <tt>-11</tt>, where <tt>this</tt> is an identity function that simply returns the item's value. The items that satisfy this expression populate the NamedArraylist that SubsetNew returns.
			For example, <tt>GT(this, -11)</tt> is the criterion <tt>this</tt> <tt>></tt> <tt>-11</tt>, where <tt>this</tt> is an identity function that simply returns the item's value. The items that satisfy this expression populate the NamedArraylist that SubsetNew returns.
	The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the ''%namrayl'' declaration and that returns a numeric or string value. This is described further in "[[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]".</td></tr>		The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the ''%namrayl'' declaration and that returns a numeric or string value. This is described further in "[[SelectionCriterion class#Specifying a SelectionCriterion's parameters\|Specifying a SelectionCriterion's parameters]]".</td></tr>
	~~</p>~~
	</table>		</table>
	==Usage notes==		==Usage notes==

← Older revision		Revision as of 16:40, 3 August 2012
Line 45:		Line 45:
	==See also==		==See also==
	<ul><li><var>[[FindNextItem (NamedArraylist function)\|FindNextItem]]</var> is similar to <var>SubsetNew</var> except that it returns just the first matching item it encounters.		<ul><li><var>[[FindNextItem (NamedArraylist function)\|FindNextItem]]</var> is similar to <var>SubsetNew</var> except that it returns just the first matching item it encounters.
			<li>The <var>UnicodeNamedArraylist</var> <var>[[SubsetNew (UnicodeNamedArraylist function)\|SubsetNew]]</var> and <var>FloatNamedArraylist</var> <var>[[SubsetNew (FloatNamedArraylist function)\|SubsetNew]]</var> functions also perform the subsetting function — for their respective classes. The examples on those pages may provide for possible additional approaches for <var>SubsetNew</var>.
	</ul>		</ul>
	{{Template:NamedArraylist:SubsetNew footer}}		{{Template:NamedArraylist:SubsetNew footer}}