FindNextItem (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to template and fix tags)
 
(22 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Template:Arraylist:FindNextItem subtitle}}
{{Template:Arraylist:FindNextItem subtitle}}
 
<var>FindNextItem</var> searches "forward" in the <var>Arraylist</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.
This function searches "forward" in the <var>Arraylist</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.


==Syntax==
==Syntax==
{{Template:Arraylist:FindNextItem syntax}}
{{Template:Arraylist:FindNextItem syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%item</i></th>
<tr><th>%item</th>
<td>A variable of the type of the items in the <var>Arraylist</var> to contain the item that is located by the search. </td></tr>
<td>A variable of the type of the items in the <var>Arraylist</var> to contain the item that is located by the search. </td></tr>
<tr><th><i>al</i></th><td>An <var>Arraylist</var> object.</td></tr>
 
<tr><th><i>selectionCriterion</i></th><td>A <var class="term">[[SelectionCriterion class|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</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. For example, <code>GT(this, -11)</code> is the criterion <code>this</code> <code>></code> <code>-11</code>, where <code>this</code> 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>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">al</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>
<tr><th>al</th>
<tr><th><b>Start</b></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 Start 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 collection. For a collection of three items, <var class="term">number</var> 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">Start</var> is required.</p></td></tr>
<td>An <var>Arraylist</var> object.</td></tr>
 
<tr><th>selectionCriterion</th>
<td>A <var>[[SelectionCriterion class|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</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 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>
<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">al</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>
 
<tr><th><var>Start</var></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>Start</var> is 2, item 3 is the first item considered. The value of <var>Start</var> may be 0 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 0, 1, 2, or 3.
<p>
The default value for <var>Start</var> is <code>0</code>; to start from the first item in <var class="term">al</var>.</p>
<p>
This is an optional, but [[Notation conventions for methods#Named parameters|name required]], argument; if you specify a value, the parameter name <var>Start</var> is required.</p></td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
<ul><li>If the value of Start is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of Start is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class|ItemNotFound]]</var> exception is thrown.
<ul>
<li><var>[[FindPreviousItem (Arraylist function)|FindPreviousItem]]</var> is identical to <var>FindNextItem</var> except that it searches backward in the <var>Arraylist</var>.
<li>If the value of <var>Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var>Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class|ItemNotFound]]</var> exception is thrown.</li>
<li><var>FindNextItem</var> is available in <var class="product">Sirius Mods</var> version 7.6 and later.
 
<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.6 and later.</li>
 
<li>If you want to search through an <var>Arraylist</var> for multiple items, or if you are interested in the item number of the matching item, use <var>[[FindNextItemNumber (Arraylist function)|FindNextItemNumber]]</var> instead of <var>FindNextItem</var>.
</ul>
</ul>


==Examples==
==Examples==
<ol>
The following request contains three <var>FindNextItem</var> calls, two with a simple selection criterion and one with a compound criterion.  The second <var>FindNextItem</var> call fails, but a Try clause catches the exception and issues a third <var>FindNextItem</var> call:
<li>The following request contains three <var>FindNextItem</var> calls, two with a simple selection criterion and one with a compound criterion.  The second <var>FindNextItem</var> call fails, but a Try clause catches the exception and issues a third <var>FindNextItem</var> call:
<p class="code">begin
<p class="code">Begin
   %al is  arraylist of float
   %al is  arraylist of float
   %al = list(111, 29, 0, 93, 77, -345)
   %al = list(111, 29, 0, 93, 77, -345)


   %sel1 is object selectioncriterion for float
   %sel1 is object [[SelectionCriterion class|selectioncriterion]] for float
   %sel2 is object selectioncriterion for float
   %sel2 is object selectioncriterion for float
   %sel1 = GT(this, 0)
   %sel1 = GT(this, 0)
   %sel2 = AND(GE(this, 50), LT(this, 93))
   %sel2 = AND(GE(this, 50), LT(this, 93))


   printtext {~} is: {%al:findNextItem(%sel1, start=2)}
   [[PrintText statement|printText]] {~} is: {%al:findNextItem(%sel1, start=2)}
 
   try printtext {~} is: {%al:findNextItem(%sel1, start=4)}
   try printtext {~} is: {%al:findNextItem(%sel1, start=4)}
       catch ItemNotFound
       catch ItemNotFound
         Print '***Does not work***'
         print '***Does not work***'
         try printtext {~} is: {%al:findNextItem(%sel2)}
         try printtext {~} is: {%al:findNextItem(%sel2)}
         catch ItemNotFound
         catch ItemNotFound
             Print '***Does not work***'
             print '***Does not work***'
         end try
         end try
   end try
   end try
 
end
End
</p>
</p>


Line 51: Line 65:
%al:findNextItem(%sel2) is: 77
%al:findNextItem(%sel2) is: 77
</p>
</p>
</ol>


==See also==
==See also==
<ul><li><var>[[FindPreviousItem (Arraylist function)|FindPreviousItem]]</var> is identical to <var>FindNextItem</var> except that it searches backward in the <var>Arraylist</var>.</ul>
{{Template:Arraylist:FindNextItem footer}}
{{Template:Arraylist:FindNextItem footer}}

Latest revision as of 16:18, 20 February 2013

Find matching Arraylist item (Arraylist class)

FindNextItem searches "forward" in the Arraylist 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 = al:FindNextItem( selectionCriterion, [Start= number]) Throws ItemNotFound

Syntax terms

%item A variable of the type of the items in the Arraylist to contain the item that is located by the search.
al An Arraylist object.
selectionCriterion A selectionCriterion object, which is a relational expression that is applied to an al item value 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 al 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 collection. For a collection of three items, number may be 0, 1, 2, or 3.

The default value for Start is 0; to start from the first item in al.

This is an optional, but name required, argument; if you specify a value, the parameter name Start is required.

Usage notes

  • If the value of Start is greater than the number of items in the Arraylist, 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.
  • If you want to search through an Arraylist for multiple items, or if you are interested in the item number of the matching item, use FindNextItemNumber instead of FindNextItem.

Examples

The following request contains three FindNextItem calls, two with a simple selection criterion and one with a compound criterion. The second FindNextItem call fails, but a Try clause catches the exception and issues a third FindNextItem call:

begin %al is arraylist of float %al = list(111, 29, 0, 93, 77, -345) %sel1 is object selectioncriterion for float %sel2 is object selectioncriterion for float %sel1 = GT(this, 0) %sel2 = AND(GE(this, 50), LT(this, 93)) printText {~} is: {%al:findNextItem(%sel1, start=2)} try printtext {~} is: {%al:findNextItem(%sel1, start=4)} catch ItemNotFound print '***Does not work***' try printtext {~} is: {%al:findNextItem(%sel2)} catch ItemNotFound print '***Does not work***' end try end try end

The result is:

%al:findNextItem(%sel1, start=2) is: 93 %al:findNextItem(%sel1, start=5) is: ***Does not work*** %al:findNextItem(%sel2) is: 77

See also

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