COLLECTION Object

Collection()

Constructor (initializes all the object settings).

Scope (COLLECTION)

Empties the current scope list and makes the passed Collection the current scope.

Scope (DBREF)

Empties the current scope list and makes the passed DBREF the current scope.

AddScope

Adds the passed DBREF to the current scope list.

Scope (DBREF ARRAY)

Replaces the current scope list with the passed list of DBREFs.

AppendScope (DBREF ARRAY)

Appends the passed list of DBREFs to the scope list.

ClearScope()

Empties the current scope list.

Filter (EXPRESSION)

Sets the filter to be applied to the collection.

ClearFilter ()

Empties the filter to be applied to the collection.

Type (STRING)

Empties the current scope type list and adds the passed element type.

AddType(STRING)

Adds the passed element type to the scope type list.

ClearTypes()

Empties the types to be applied to the collection.

Types (ARRAY elements)

Replaces the scope element type list with the passed list, elements.

AppendTypes (ARRAY types)

Appends the passed list, types, to the scope type list.

Initialise()

Initializes an evaluate list, so all query actions re-evaluate the collection rules.

Sets index position to 1.

Filter()

EXPRESSION

Returns the expression used to filter database elements.

Scope()

DBREF ARRAY

Returns the list of database elements to scan.

Types()

STRING ARRAY

Returns the list of database element types to be collected.

Results()

DBREF ARRAY

Returns the whole collection.

Next(REAL n)

DBREF ARRAY

Returns sub array from collection of n elements starting at current index position.

Index()

REAL

Returns the current index of the count being used by Next().

Size ()

REAL

Returns the number of elements in the collection.