A list collection represents a list of data type elements, each of which is associated with a numeric position in the list. More...

Inheritance diagram for AbstractList:

[legend]

Collaboration diagram for AbstractList:

[legend]

Public Member Functions
_.Library.Status	Clear ()
	Clears the contents of the list. More...

_.Library.Integer	Count ()
	Returns the number of elements contained in the list.

_.Library.String	Find (_.Library.RawString element, _.Library.Integer key)
	Starting from, but not including, position key, Find finds. More...

_.Library.RawString	GetAt (_.Library.Integer key)
	Finds and returns the value of the element at position. More...

_.Library.RawString	GetNext (_.Library.Integer key)
	Finds and returns the value of the element at the position after key More...

_.Library.RawString	GetPrevious (_.Library.Integer key)
	Finds and returns the value of the element at the position before key More...

_.Library.Status	Insert (_.Library.RawString element)
	Inserts an element with value element at the end of the list. More...

_.Library.Status	InsertAt (_.Library.RawString element, _.Library.Integer key)
	Inserts an element with value element at position key. More...

_.Library.Status	InsertList (_.Library.RawString inslist)
	Inserts a list with value inslist at the end of the list. More...

_.Library.Status	InsertOrdered (_.Library.RawString element)
	Inserts an element with value element into the list at the correct ordered. More...

_.Library.Integer	Next (_.Library.Integer key)
	Finds and returns the index value of the element at the location following key in the list. More...

_.Library.Integer	Previous (_.Library.Integer key)
	Finds and returns the index value of the element at the location preceding key in the list. More...

_.Library.RawString	RemoveAt (_.Library.Integer key)
	Removes the element at position key in the list. More...

_.Library.Status	SetAt (_.Library.RawString element, _.Library.Integer key)
	Sets the value of the element at position key to element. More...

Public Member Functions inherited from AbstractIterator
_.Library.RawString	GetAt (_.Library.RawString key)
	Definition of iterator methods that all our collections classes use to ensure consistency. More...

_.Library.RawString	GetNext (_.Library.RawString key)
	Finds and returns the value of the element at the location after key More...

_.Library.RawString	Next (_.Library.RawString key)
	Finds and returns the key value of the element at the location following key in the iteration. More...

Static Public Member Functions
_.Library.Status	BuildValueArray (_.Library.Binary serialized, _.Library.Binary array)
	Constructs array(key)=value for each element in the serialval value. More...

_.Library.String	LogicalToOdbc (_.Library.String val, _.Library.String delim, _.Library.String class, _.Library.String method)
	Converts the serial state of this list object to a delimited string. More...

_.Library.String	OdbcToLogical (_.Library.String val, _.Library.String delim, _.Library.String class, _.Library.String method)
	Converts the value of an incoming delimited string to a serialized state. More...

Private Member Functions
_.Library.Boolean	IsNull ()
	A list collection represents a list of data type elements, each of which is associated with a numeric position in the list. More...

Detailed Description

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 <CLASS>Collection.AbstractList</CLASS> class provides the basic functionality of the
various list collection classes.

The non-abstract list classes derived from <CLASS>AbstractList</CLASS> include <CLASS>ListOfDataTypes</CLASS>, <CLASS>ListOfObjects</CLASS>, <CLASS>Collection.ListOfObj</CLASS> and <CLASS>Collection.ListOfDT</CLASS>.

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),!

Member Function Documentation

◆ IsNull()

_.Library.Boolean IsNull ( )

private

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 <CLASS>Collection.AbstractList</CLASS> class provides the basic functionality of the
various list collection classes.

The non-abstract list classes derived from <CLASS>AbstractList</CLASS> include <CLASS>ListOfDataTypes</CLASS>, <CLASS>ListOfObjects</CLASS>, <CLASS>Collection.ListOfObj</CLASS> and <CLASS>Collection.ListOfDT</CLASS>.

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),!

A collection is null if it does not contain any elements

◆ BuildValueArray()

_.Library.Status BuildValueArray	(	_.Library.Binary	serialized,
		_.Library.Binary	array
	)

static

Constructs array(key)=value for each element in the serialval value.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

◆ Clear()

_.Library.Status Clear ( )

Clears the contents of the list.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

Reimplemented in ListOfObjects, and ListOfDataTypes.

◆ Find()

_.Library.String Find	(	_.Library.RawString	element,
		_.Library.Integer	key
	)

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()

_.Library.RawString GetAt ( _.Library.Integer key )

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.

Reimplemented in QueryHelper, ListOfStream, ListOfObj, ListOfDT, AbstractListOfObj, and AbstractListOfDT.

◆ GetNext()

_.Library.RawString GetNext ( _.Library.Integer key )

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.

Reimplemented in QueryHelper, ListOfObj, ListOfDT, AbstractListOfObj, and AbstractListOfDT.

◆ GetPrevious()

_.Library.RawString GetPrevious ( _.Library.Integer key )

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.

Reimplemented in ListOfObj, ListOfDT, AbstractListOfObj, and AbstractListOfDT.

◆ Insert()

_.Library.Status Insert ( _.Library.RawString element )

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

<p>Returns a <CLASS>%Status</CLASS> value indicating success or failure.

◆ InsertAt()

_.Library.Status InsertAt	(	_.Library.RawString	element,
		_.Library.Integer	key
	)

Inserts an element with value element at position key.

<p>To make room for the new element, the elements previously at or following position 
<var>key</var> are moved up by one position.
<p><var>key</var> must be in the following range: 
<blockquote><code>
1 &lt= key &lt= Count() + 1
</blockquote></code>

Returns a <CLASS>%Status</CLASS> value indicating success or failure.

◆ InsertList()

_.Library.Status InsertList ( _.Library.RawString inslist )

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

<p>Returns a <CLASS>%Status</CLASS> value indicating success or failure.

◆ InsertOrdered()

_.Library.Status InsertOrdered ( _.Library.RawString element )

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 <CLASS>Status</CLASS> value indicating success or failure.

◆ LogicalToOdbc()

_.Library.String LogicalToOdbc	(	_.Library.String	val,
		_.Library.String	delim,
		_.Library.String	class,
		_.Library.String	method
	)

static

Converts the serial state of this list object to a delimited string.

using "," as a delimiter.

Reimplemented in ListOfObj, and ListOfDT.

◆ Next()

_.Library.Integer Next ( _.Library.Integer key )

Finds and returns the index value of the element at the location following key in the list.

If key is a null string (""), then Next returns the position of the first element in the list (1).

Reimplemented in ListOfObj, and ListOfDT.

◆ OdbcToLogical()

_.Library.String OdbcToLogical	(	_.Library.String	val,
		_.Library.String	delim,
		_.Library.String	class,
		_.Library.String	method
	)

static

Converts the value of an incoming delimited string to a serialized state.

using "," as a delimiter.

Reimplemented in ListOfObj, and ListOfDT.

◆ Previous()

_.Library.Integer Previous ( _.Library.Integer key )

Finds and returns the index value of the element at the location preceding key in the list.

If key is a null string (""), then Previous returns the position of the last element in the list.

Reimplemented in ListOfObj, and ListOfDT.

◆ RemoveAt()

_.Library.RawString RemoveAt ( _.Library.Integer key )

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.

Reimplemented in ListOfDT, and AbstractListOfDT.

◆ SetAt()

_.Library.Status SetAt	(	_.Library.RawString	element,
		_.Library.Integer	key
	)

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

Returns a <CLASS>Status</CLASS> value indicating success or failure.

Public Member Functions

Static Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

◆ IsNull()

◆ BuildValueArray()

◆ Clear()

◆ Find()

◆ GetAt()

◆ GetNext()

◆ GetPrevious()

◆ Insert()

◆ InsertAt()

◆ InsertList()

◆ InsertOrdered()

◆ LogicalToOdbc()

◆ Next()

◆ OdbcToLogical()

◆ Previous()

◆ RemoveAt()

◆ SetAt()