FindNextItem (GenericNamedArraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (match syntax table to diagram, couple of tags, lots of edits)
Line 1: Line 1:
{{Template:GenericNamedArraylist:FindNextItem subtitle}}
{{Template:GenericNamedArraylist:FindNextItem subtitle}}


This function searches "forward" in the NamedArraylist to find and return
<var>FindNextItem</var> searches "forward" in the <var>NamedArraylist</var> to find and return the next item that matches a specified criterion. The criterion is supplied by the <var>[[SelectionCriterion class|SelectionCriterion]]</var> object that is a required <var>FindNextItem</var> parameter. If no item satisfies the criterion, the request is cancelled and an <var>[[ItemNotFound class|ItemNotFound]]</var> exception is thrown.
the next item that matches a specified criterion.
The criterion is supplied by the [[SelectionCriterion class|SelectionCriterion]] object
that is a required FindNextItem parameter.
If no item satisfies the criterion,
the request is cancelled and an ItemNotFound exception ([[??]] refid=itemnfe.)
is thrown.


FindNextItem is available in ''Sirius Mods'' version 7.6 and later.
==Syntax==
==Syntax==
{{Template:GenericNamedArraylist:FindNextItem syntax}}
{{Template:GenericNamedArraylist:FindNextItem syntax}}
Line 15: Line 8:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%item</th>
<tr><th>%item</th>
<td>A variable of the type of the items in the NamedArraylist to contain the item that is located by the search. </td></tr>
<td>A variable of the type of the items in the <var>NamedArraylist</var> to contain the item that is located by the search.</td></tr>
<tr><th>%namrayl</th>
<tr><th>anyNal</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 class|SelectionCriterion]]</var> object, which is a relational expression that is applied to a <var class="term">anyNal</var> item values 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 class="term">this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindNextItem</var> that satisfies this expression is the method's return value.</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 first item tested by FindNextItem that satisfies this expression is the method's return value.
<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">anyNal</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>
<tr><th>Start</th>
<tr><th>Start= itemnum</th>
<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the <var class="term">number</var> value of <var class="term">Start</var> is 2, item 3 is the first item considered. The value of <var class="term">Start</var> may be 0 through the number of items in the <var>NamedArraylist</var>. For a <var>NamedArraylist</var>of three items, <var class="term">number</var> may be 0, 1, 2, or 3.
<td>The number of the item ''after'' which to begin the search. If the ''itemnum'' value of Start is 2, item 3 is the first item considered. The value of Start may be 0 through the number of items in the NamedArraylist. For a NamedArraylist of three items, ''itemnum'' may be 0, 1, 2, or 3.
<p>This is an optional argument, and it defaults to 0. If you specify a value, the parameter name <var class="term">number</var> is required.</p></td></tr>
 
</table>
This is an optional argument, and it defaults to 0. If you specify a value, the parameter name <tt>Start</tt> is required.</td></tr>


</table>
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>If the value of Start is greater than the number of items in the NamedArraylist,
<li>If the value of <var class="term">Start</var> is greater than the number of items in the <var>NamedArraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class|ItemNotFound]]</var> exception is thrown.
the request is cancelled.
<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.6 and later.
If the value of Start is equal to the number of items,
the request is cancelled, but an ItemNotFound exception is thrown.
<li>The [[FindPreviousItem (NamedArraylist function)|FindPreviousItem]] function
is identical to FindNextItem except that it searches backward in the NamedArraylist.
</ul>
</ul>
==Examples==
==Examples==
 
<ol><li>
The following request contains two FindNextItem calls and one FindPreviousItem
The following request contains two FindNextItem calls and one FindPreviousItem
call, each with a class Variable as the function in the SelectionCriterion:
call, each with a class Variable as the function in the SelectionCriterion:
Line 89: Line 77:
White tired
White tired
Red employed
Red employed
</p>
</p></ol>
 
==See also==
==See also==
<ul><li><var>[[FindPreviousItem (NamedArraylist function)|FindPreviousItem]]</var> is identical to <var>FindNextItem</var> except that it searches backward in the <var>NamedArraylist</var>.</ul>
{{Template:GenericNamedArraylist:FindNextItem footer}}
{{Template:GenericNamedArraylist:FindNextItem footer}}

Revision as of 08:32, 2 March 2011

Next item that matches some selection criteria (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)


FindNextItem searches "forward" in the NamedArraylist to find and return the next item that matches a specified criterion. The criterion is supplied by the SelectionCriterion object that is a required FindNextItem parameter. If no item satisfies the criterion, the request is cancelled and an ItemNotFound exception is thrown.

Syntax

%item = anyNal:FindNextItem( selectionCriterion, [Start= number]) Throws ItemNotFound

Syntax terms

%item A variable of the type of the items in the NamedArraylist to contain the item that is located by the search.
anyNal A NamedArraylist object.
selectionCriterion A SelectionCriterion object, which is a relational expression that is applied to a anyNal item values to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.

For example, GT(this, -11) is the criterion this > -11, where this is an identity function that simply returns the item's value. The first item tested by FindNextItem that satisfies this expression is the method's return value.

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 anyNal declaration and that returns a numeric or string value. This is described further in "Specifying a SelectionCriterion's parameters".

Start The number of the item after which to begin the search. If the number value of Start is 2, item 3 is the first item considered. The value of Start may be 0 through the number of items in the NamedArraylist. For a NamedArraylistof three items, number may be 0, 1, 2, or 3.

This is an optional argument, and it defaults to 0. If you specify a value, the parameter name number is required.

Usage notes

  • If the value of Start is greater than the number of items in the NamedArraylist, the request is cancelled. If the value of Start is equal to the number of items, the request is cancelled, but an ItemNotFound exception is thrown.
  • FindNextItem is available in "Sirius Mods" Version 7.6 and later.

Examples

  1. The following request contains two FindNextItem calls and one FindPreviousItem call, each with a class Variable as the function in the SelectionCriterion:

    Begin class staff public variable name is string len 20 variable status is string len 8 constructor newf(%a is string len 10, - %b string len 8) function myprint is longstring end public constructor newf(%a is string len 10, - %b string len 8) %this:name = %a %this:status = %b end constructor function myprint is longstring return %this:name with ' ' with %this:status end function end class %stf is object staff %old is namedArraylist of object staff %old = new %old('Jim') = newf('Red', 'employed') %old('Jed') = newf('Black', 'retired') %old('Jan') = newf('Green', 'employed') %old('Jud') = newf('Brown', 'retired') %old('Jon') = newf('White', 'tired') %stf = %old:findNextItem(Eq(status, 'employed')) print %stf:myprint %stf = %old:findNextItem(Gt(name, 'Starks')) print %stf:myprint %stf = %old:findPreviousItem(AND(Lt(name, 'Starks'), - Eq(status, 'employed'))) print %stf:myprint End

    The result is:

    Green employed White tired Red employed

See also

  • FindPreviousItem is identical to FindNextItem except that it searches backward in the NamedArraylist.