%Library.ArrayOfObjects
Class %Library.ArrayOfObjects Extends (%Collection.AbstractArrayOfObj, %SerialObject) [ ClassType = serial, OdbcType = VARCHAR, StorageStrategy = Custom, System = 2 ]
For information on this class, see Working with Collections.
The %ArrayOfObjects class represents an array of references to objects, each of which is associated with a unique key value. Keys can have any value, string or numeric. The objects referred to must be registered. They can be either persistent objects or non-id objects.
Internally, an %ArrayOfObjects object contains two arrays: one for holding the OID values for the objects referred to (or their serialized state in the case of an array of non-id objects); and another for holding the OREF values for any objects that have been explicitly referred to, and hence "swizzled" into memory. Swizzling (loading an object into memory and generating an OREF value for it) happens automatically whenever the user refers to an object within the array.
For example, if array is an %ArrayOfObjects object containing an array of Doctor objects (that is an array of OID values for Doctor objects stored in the database) then the following code fragment will automatically load the Doctor object associated with the key "Primary" into memory and generate an OREF value referring to the in-memory version of the Doctor object. This OREF value can then be used to access the properties and methods of the Doctor object: Set doc=array.GetAt("Primary") Write doc.Name
Alternatively, we could use cascading dot syntax: Set name=array.GetAt("Primary").Name
When the %ArrayOfObjects object is closed (removed from memory), it will close (call %Close on) all of the references it has swizzled into memory. These classes can be used 'standalone' to store a collection.
Parameters
CLASSNAMEINOID
Parameter CLASSNAMEINOID = 0;
This parameter determines how the collection object stores OID values. If this parameter is set to 0, then partially-formed OID values, containing only an ID number, are used. If this parameter is set to 1, then fully-formed OID values, containing both a class name and an ID number, are used.
ELEMENTTYPE
Parameter ELEMENTTYPE = "%RegisteredObject";
The type (class name) of the elements stored in the collection.
Properties
Oref
Property Oref As %String [ MultiDimensional ];
Private storage area used to hold OREF values.
ElementType
Property ElementType As %String(MAXLEN = 256) [ InitialExpression = {..#ELEMENTTYPE} ];
The type (class name) of the elements stored in the collection.
Data
Property Data As %String [ MultiDimensional ];
Data is a private property used to hold the contents of the array.
Methods
Count
Method Count() As %Integer [ ProcedureBlock = 1 ]
Returns the number of elements contained in the array.
IsDefined
Method IsDefined(key As %String) As %Boolean [ CodeMode = expression, Final ]
Returns true (1) if a value is defined at location key, otherwise false (0).
Define
Method Define(key As %String) As %Boolean [ CodeMode = expression, Deprecated, Final ]
This method is deprecated.
Please use IsDefined instead.
Next
Method Next(key As %String = "") As %String [ CodeMode = expression, Final ]
Finds and returns the key value of the element at the location following key in the array. If key is a null string (""), then Next returns the key value for the first element in the array.
Previous
Method Previous(key As %String = "") As %String [ CodeMode = expression, Final ]
Finds and returns the key value of the element at the location preceding key in the array. If key is a null string (""), then Next returns the key value for the last element in the array.
BuildValueArray
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.
Clear
Method Clear() As %Status
Clears the contents of the array. Both the OID and OREF values are cleared.
Returns a %Status value indicating success or failure.
Find
Method Find(element As %ObjectIdentity, key As %String) As %String [ CodeMode = generator ]
Starting from, but not including, location key, finds the next element in the array whose OID value equals 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.
FindObjectId
Method FindObjectId(id As %String, key As %Integer) As %String
Starting from, but not including, position key, FindObjectId finds the next element in the list whose ObjectId equals id. 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 %String) As %RegisteredObject
Finds and returns the OREF value of the element associated with key.
GetAt returns the OREF value of the element associated with key or null string ("") if no element is found.
GetObjectAt
Method GetObjectAt(key As %String, force As %Integer = 0) As %ObjectIdentity
Finds and returns the OID value of the element associated with key.
GetObjectAt returns the OID value of the element associated with key or null string ("") if no element is found.
GetObjectIdAt
Method GetObjectIdAt(key As %String, force As %Integer = 0) As %String [ CodeMode = expression ]
Finds and returns the ID value of the element associated with key.
GetObjectIdAt returns the ID value of the element associated with key or null string ("") if no element is found.
GetNext
Method GetNext(ByRef key As %String) As %RegisteredObject
Finds and returns the OREF value of the element at the location after key in the array. If key is a null string (""), it returns the OREF value of the first 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 end of the array.
GetObjectNext
Method GetObjectNext(ByRef key As %String) As %ObjectIdentity
Finds and returns the OID value of the element at the location after key in the array. If key is a null string (""), it returns the OID value of the first 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 end of the array.
GetObjectIdNext
Method GetObjectIdNext(ByRef key As %String) As %String [ CodeMode = expression ]
Finds and returns the ID value of the element at the location after key in the array. If key is a null string (""), it returns the ID value of the first 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 end of the array.
GetPrevious
Method GetPrevious(ByRef key As %String) As %RegisteredObject
Finds and returns the OREF value of the element at the location before key in the array. If key is a null string (""), it returns the OREF 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.
GetObjectPrevious
Method GetObjectPrevious(ByRef key As %String) As %ObjectIdentity
Finds and returns the OID value of the element at the location before key in the array. If key is a null string (""), it returns the OID 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.
GetObjectIdPrevious
Method GetObjectIdPrevious(ByRef key As %String) As %String [ CodeMode = expression ]
Finds and returns the ID value of the element at the location before key in the array. If key is a null string (""), it returns the ID 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.
RemoveAt
Method RemoveAt(key As %String, Output success As %Boolean) As %ObjectIdentity
Removes the element associated with key in the array.
RemoveAt returns the OID value of the removed element or null string ("") if no element was removed. It also has a success output argument that returns true if the item was removed and false if it was not.
SetAt
Method SetAt(oref As %RegisteredObject, key As %String) As %Status
Sets the OREF value of the element associated with key to element.
Returns a %Status value indicating success or failure.
SetObjectAt
Method SetObjectAt(oid As %ObjectIdentity, key As %String) As %Status
Sets the OID value of the element associated with key to element.
Returns a %Status value indicating success or failure.
SetObjectIdAt
Method SetObjectIdAt(id As %String, key As %String) As %Status [ CodeMode = expression ]
Sets the ID value of the element associated with key to element.
Returns a %Status value indicating success or failure.
%AddToSaveSet
Method %AddToSaveSet(force As %Integer = 0, refresh As %Integer = 0) As %Status
Overrides %SerialObject implementation. Scans objects for modifications in the related list (Element) and the terminated relationship list (DeleteOref). Modified/Scheduled to delete objects are added to the save graph.
%SerializeObject
Method %SerializeObject(ByRef serial As %Binary, partial As %Integer = 0) As %Status
%UnSwizzleAt
Method %UnSwizzleAt(key As %String, force As %Integer = 0) As %Status [ ProcedureBlock = 1 ]
Unswizzles (removes from memory) the element associated with key in the array.
Returns a %Status value indicating success or failure.
%GetSerial
Method %GetSerial(force As %Integer = 0) As %String [ CodeMode = generator, Private ]
%SetSerial
Method %SetSerial(serialized As %String) As %Status [ Private ]
%OnConstructClone
Method %OnConstructClone(oref As %RegisteredObject, deep As %Boolean = 0, ByRef cloned As %String) As %Status [ Private, ProcedureBlock = 1 ]
%OnNew
Method %OnNew(initvalue As %String) As %Status [ Private ]