FindNextItem (GenericNamedArraylist function)
Next item that matches some selection criteria (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
FindNextItem searches "forward" in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist 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 item in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist to contain the item that is located by the search. |
|---|---|
| anyNal | A FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist 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, 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 FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist. For an array list of three items, number may be 0, 1, 2, or 3.
This is an optional, name required, argument which 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 FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist, 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
Successful selection
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
Failed selection, UnicodeNamedArraylist
The following fragment also contains one FindNextItem call and one FindPreviousItem call. The FindPreviousItem call finds no matching item:
%k is unicodeNamedArraylist of longstring %k = new %k('§Jan':u) = 'Orion' %k('§Apr':u) = 'Leo' %k('§Mar':u) = 'Cancer' %k('§Jun':u) = 'Ursa Minor' %k('§Nov':u) = 'Andromeda' %k('§Dec':u) = 'Aries' %k('§Feb':u) = 'Canis Major' %sel is object selectionCriterion for longstring %sel2 is object selectionCriterion for longstring %sel = OR(LT(this, 'C'), EQ(this, 'Taurus')) %sel2 = EQ(this, 'Taurus') print %k:findNextitem(%sel) print %k:findPreviousitem(%sel2)
The result is:
Aries CANCELLING REQUEST: MSIR.0750: Class UnicodeNamedArraylist, function FindPreviousItem: ItemNotFound exception: no items match SelectionCriterion in line 18
See also
- FindPreviousItem is identical to FindNextItem except that it searches backward in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist.