FindNextItem (Arraylist function)

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 NameRequired, 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 one wishes to search through an Arraylist for multiple items or one is interested in the item number of the matching item, one should probably 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.

Arraylist class FloatNamedArraylist class NamedArraylist class UnicodeNamedArraylist class	List of Arraylist methods List of FloatNamedArraylist methods List of NamedArraylist methods List of UnicodeNamedArraylist methods List of Collection methods	Arraylist methods syntax FloatNamedArraylist methods syntax NamedArraylist methods syntax UnicodeNamedArraylist methods syntax
Notation conventions for methods