Skip to main content

%Collection.AbstractListOfDT

Class %Collection.AbstractListOfDT Extends %Collection.AbstractList [ System = 2 ]

A list collection represents a list of data type elements, each of which is associated with a numeric position in the list. The first element in the list is stored at position 1.

The %Collection.AbstractList class provides the basic functionality of the various list collection classes.

The non-abstract list classes derived from %AbstractList include %ListOfDataTypes, %ListOfObjects, %Collection.ListOfObj and %Collection.ListOfDT. You can use a list object as follows: Set list=##class(%ListOfDataTypes).%New() ; add items to the list Do list.Insert("Harpo") Do list.Insert("Groucho") Do list.Insert("Chico") Do list.Insert("Karl") ; iterate over contents of list For i=1:1:list.Count() Write list.GetAt(i),!

Methods​

Find​

Method Find(element As %String, key As %Integer) As %String [ Abstract ]

Starting from, but not including, position key, Find finds the next element in the list with value equal to element. If key is a null string, Find starts at the beginning of the list.

Find returns the position of the found element or null string ("") if no element was found.

GetAt​

Method GetAt(key As %Integer = 0) As %String [ Abstract ]

Finds and returns the value of the element at position key in the list.

GetAt returns the value of the element at location key or null string ("") if no element is found.

GetNext​

Method GetNext(ByRef key As %Integer) As %String [ Abstract ]

Finds and returns the value of the element at the position after key in the list. If key is a null string (""), it returns the value of the first element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the end of the list.

GetPrevious​

Method GetPrevious(ByRef key As %Integer) As %String [ Abstract ]

Finds and returns the value of the element at the position before key in the list. If key is a null string (""), it returns the value of the last element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the beginning of the list.

Insert​

Method Insert(element As %String) As %Status [ Abstract ]

Inserts an element with value element at the end of the list.

Returns a %Status value indicating success or failure.

InsertAt​

Method InsertAt(element As %String, key As %Integer) As %Status [ Abstract ]

Inserts an element with value element at position key.

To make room for the new element, the elements previously at or following position key are moved up by one position.

key must be in the following range: 1 <= key <= Count() + 1 Returns a %Status value indicating success or failure.

InsertList​

Method InsertList(inslist As %String) As %Status [ Abstract ]

Inserts a list with value inslist at the end of the list.

Returns a %Status value indicating success or failure.

InsertOrdered​

Method InsertOrdered(element As %String) As %Status [ Abstract ]

Inserts an element with value element into the list at the correct ordered position. The elements in the list are shifted to accommodate the new element as necessary.

Returns a %Status value indicating success or failure.

RemoveAt​

Method RemoveAt(key As %Integer) As %String [ Abstract ]

Removes the element at position key in the list. The elements following position key are moved to fill in the resulting gap.

RemoveAt returns the value of the removed element or null string ("") if no element was removed.

SetAt​

Method SetAt(element As %String, key As %Integer) As %Status [ Abstract ]

Sets the value of the element at position key to element.

Returns a %Status value indicating success or failure.