Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %Collection.AbstractArray
Private  Storage   

%Collection.AbstractArray


abstract class %Collection.AbstractArray extends
%Collection.AbstractIterator

An array collection represents an array of data type elements, each of which is associated with a unique key value. Keys can have any value, string or numeric.

The %Collection.AbstractArray class provides the basic functionality of the various array collection classes.

The non-abstract array classes derived from %AbstractArray include %ArrayOfDataTypes, %ArrayOfObjects, %Collection.ArrayOfObj and %Collection.ArrayOfDT.

You can use an array object as follows:

	Set arr=##class(%ArrayOfDataTypes).%New()
	; place items into the array
	Do arr.SetAt("red","color")
	Do arr.SetAt("large","size")
	Do arr.SetAt("expensive","price")
	; iterate over contents of array
	Set key=""
	For  Set value=arr.GetNext(.key) Quit:key=""  Write key,":",value,!

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 13


Summary


Methods
%IsNull BuildValueArray Clear Count
Define Find GetAt GetNext
GetPrevious IsDefined LogicalToOdbc Next
OdbcToLogical Previous RemoveAt SetAt

Subclasses
%Collection.AbstractArrayOfDT %Collection.AbstractArrayOfObj %Library.AbstractArray

Parameters


• parameter ELEMENTTYPE = "%String";
The type (class name) of the elements stored in the collection.

Methods


• method %IsNull() as %Boolean
A collection is null if it does not contain any elements
• classmethod BuildValueArray(serialized As %Binary, array As %Binary) as %Status
Constructs array(key)=value for each element in the serialval value.

Returns a %Status value indicating success or failure.

• abstract method Clear() as %Status
Clears the contents of the array.

Returns a %Status value indicating success or failure.

• abstract method Count() as %Integer
Returns the number of elements contained in the array.
• abstract method Define(key As %String) as %Boolean
This method is deprecated.

Please use IsDefined instead.

• abstract method Find(element As %RawString, key As %String) as %String
Starting from, but not including, location key, finds the next element in the array with value equal to element.

If key is a null string (""), the search starts at the beginning of the array.

Find returns the key associated with the found element or null string ("") if no element is found.

• abstract method GetPrevious(ByRef key As %String) as %RawString
Finds and returns the value of the element at the location before key in the array. If key is a null string (""), it returns the value of the last element in the array.

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

• abstract method IsDefined(key As %String) as %Boolean
Returns true (1) if a value is defined at location key, otherwise false (0).
• classmethod LogicalToOdbc(val As %String = "", delim As %String = ",", class As %String = "", method As %String = "") as %String
Converts the serial state of this array object to a delimited string using delim as a delimiter.
• classmethod OdbcToLogical(val As %String = "", delim As %String = ",", class As %String = "", method As %String = "") as %String
Converts the value of an incoming delimited string to a serialized state using delim as a delimiter.
• abstract method Previous(key As %String = "") as %String
Finds and returns the key value of the element at the location preceding key in the array. If key is a null string (""), then Previous returns the key value for the last element in the array.
• abstract method RemoveAt(key As %String) as %RawString
Removes the element associated with key in the array.

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

• abstract method SetAt(element As %RawString, key As %String) as %Status
Sets the value of the element associated with key to element.

Returns a %Status value indicating success or failure.