An array collection of objects. More...

Inheritance diagram for AbstractArrayOfObj:

[legend]

Collaboration diagram for AbstractArrayOfObj:

Public Member Functions
_.Library.String	Find (_.Library.ObjectIdentity element, _.Library.String key)
	An array collection of objects. More...

_.Library.String	FindObjectId (_.Library.String id, _.Library.Integer key)
	Starting from, but not including, position key, FindObjectId finds. More...

_.Library.String	FindOref (_.Library.RegisteredObject oref, _.Library.String key, _.Library.String id)
	Starting from, but not including, location key,. More...

_.Library.RegisteredObject	GetAt (_.Library.String key)
	Finds and returns the value of the element associated with key. More...

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

_.Library.ObjectIdentity	GetObjectAt (_.Library.String key, _.Library.Integer force)
	Finds and returns the OID value of the element associated with key. More...

_.Library.String	GetObjectIdAt (_.Library.String key, _.Library.Integer force)
	Finds and returns the ID value of the element associated with key. More...

_.Library.String	GetObjectIdNext (_.Library.String key)
	Finds and returns the ID value of the element at the location after key More...

_.Library.String	GetObjectIdPrevious (_.Library.String key)
	Finds and returns the ID value of the element at the location before key More...

_.Library.ObjectIdentity	GetObjectNext (_.Library.String key)
	Finds and returns the OID value of the element at the location after key More...

_.Library.ObjectIdentity	GetObjectPrevious (_.Library.String key)
	Finds and returns the OID value of the element at the location before key More...

_.Library.RegisteredObject	GetPrevious (_.Library.String key)
	Finds and returns the value of the element at the location before key More...

_.Library.ObjectIdentity	RemoveAt (_.Library.String key, _.Library.Boolean success)
	Removes the element associated with key in the array. More...

_.Library.Status	SetAt (_.Library.RegisteredObject element, _.Library.String key)
	Sets the value of the element associated with key to element. More...

_.Library.Status	SetObjectAt (_.Library.ObjectIdentity oid, _.Library.String key)
	Sets the OID value of the element associated with key to element. More...

_.Library.Status	SetObjectIdAt (_.Library.String id, _.Library.String key)
	Sets the ID value of the element associated with key to element. More...

Public Member Functions inherited from AbstractArray
_.Library.Status	Clear ()
	Clears the contents of the array. More...

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

_.Library.Boolean	Define (_.Library.String key)
	This method is deprecated. More...

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

_.Library.Boolean	IsDefined (_.Library.String key)
	Returns true (1) if a value is defined at location key,. More...

_.Library.String	Previous (_.Library.String key)
	Finds and returns the key value of the element at the location preceding key in the array. More...

_.Library.RawString	RemoveAt (_.Library.String key)
	Removes the element associated with key in the array. More...

_.Library.Status	SetAt (_.Library.RawString element, _.Library.String key)
	Sets the value of the element associated with 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...

Additional Inherited Members
Static Public Member Functions inherited from AbstractArray
_.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 array 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...

Static Public Attributes inherited from AbstractArray
	ELEMENTTYPE = None
	The type (class name) of the elements stored in the collection.

Detailed Description

An array collection of objects.

Member Function Documentation

◆ Find()

_.Library.String Find	(	_.Library.ObjectIdentity	element,
		_.Library.String	key
	)

An array collection of objects.

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.

Reimplemented in ArrayOfObjCN, and ArrayOfObj.

◆ FindObjectId()

_.Library.String FindObjectId	(	_.Library.String	id,
		_.Library.Integer	key
	)

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.

Reimplemented in ArrayOfObj.

◆ FindOref()

_.Library.String FindOref	(	_.Library.RegisteredObject	oref,
		_.Library.String	key,
		_.Library.String	id
	)

Starting from, but not including, location key,.

finds the next element in the array whose Oref value equals oref.

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

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

Unswizzled references are compared to oref.Oid() and if equal, swizzling will occur.

Reimplemented in ArrayOfObj.

◆ GetAt()

_.Library.RegisteredObject GetAt ( _.Library.String key )

Finds and returns the value of the element associated with key.

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

Reimplemented in ArrayOfStream, and ArrayOfObj.

◆ GetNext()

_.Library.RegisteredObject GetNext ( _.Library.String key )

Finds and returns the value of the element at the location after key

in the array. If key is a null string (""), it returns the 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.

Reimplemented in ArrayOfObj.

◆ GetObjectAt()

_.Library.ObjectIdentity GetObjectAt	(	_.Library.String	key,
		_.Library.Integer	force
	)

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.

Reimplemented in ArrayOfObj.

◆ GetObjectIdAt()

_.Library.String GetObjectIdAt	(	_.Library.String	key,
		_.Library.Integer	force
	)

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.

Reimplemented in ArrayOfObj.

◆ GetObjectIdNext()

_.Library.String GetObjectIdNext ( _.Library.String key )

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.

Reimplemented in ArrayOfObj.

◆ GetObjectIdPrevious()

_.Library.String GetObjectIdPrevious ( _.Library.String key )

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.

Reimplemented in ArrayOfObj.

◆ GetObjectNext()

_.Library.ObjectIdentity GetObjectNext ( _.Library.String key )

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.

Reimplemented in ArrayOfObj.

◆ GetObjectPrevious()

_.Library.ObjectIdentity GetObjectPrevious ( _.Library.String key )

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.

Reimplemented in ArrayOfObj.

◆ GetPrevious()

_.Library.RegisteredObject GetPrevious ( _.Library.String key )

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.

Reimplemented from AbstractArray.

Reimplemented in ArrayOfObj.

◆ RemoveAt()

_.Library.ObjectIdentity RemoveAt	(	_.Library.String	key,
		_.Library.Boolean	success
	)

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. It also has a success output argument that returns true if the item was removed and false if it was not.

Reimplemented in ArrayOfObj.

◆ SetAt()

_.Library.Status SetAt	(	_.Library.RegisteredObject	element,
		_.Library.String	key
	)

Sets the value of the element associated with key to element.

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

Reimplemented in ArrayOfStream, and ArrayOfObj.

◆ SetObjectAt()

_.Library.Status SetObjectAt	(	_.Library.ObjectIdentity	oid,
		_.Library.String	key
	)

Sets the OID value of the element associated with key to element.

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

Reimplemented in ArrayOfObj.

◆ SetObjectIdAt()

_.Library.Status SetObjectIdAt	(	_.Library.String	id,
		_.Library.String	key
	)

Sets the ID value of the element associated with key to element.

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

Reimplemented in ArrayOfStream, and ArrayOfObj.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Find()

◆ FindObjectId()

◆ FindOref()

◆ GetAt()

◆ GetNext()

◆ GetObjectAt()

◆ GetObjectIdAt()

◆ GetObjectIdNext()

◆ GetObjectIdPrevious()

◆ GetObjectNext()

◆ GetObjectPrevious()

◆ GetPrevious()

◆ RemoveAt()

◆ SetAt()

◆ SetObjectAt()

◆ SetObjectIdAt()