/ 
Object-Meta-1.2.0
River stage zero No dependents
/ Object::Meta::List

NAME

Object::Meta::List - Library to access Object::Meta objects by Index Value and by insertion order.

Object::Meta::List enherits from Object::Meta the capability to store Meta Data which is used to create autogenerated object indices in-memory.

METHODS

Constructor

new ( [ DATA ] )

This is the constructor for a new Object::Meta::List object.

Since Object::Meta::List is also a Object::Meta it can also hold meta data.

Parameters:

DATA

The raw data which is passed in a hash like fashion, using key and value pairs. This is passed to the inherited Object::Meta constructor.

Administration Methods

Add ( [ Object::Meta | DATA ] )

This adds new items to the list.

If no parameter is given it creates an empty instance of Object::Meta and adds it to the list

Parameters:

Object::Meta

An instance of Object::Meta to be added to the list.

DATA

A hash with data to create an instance of Object::Meta and add it to the list.

Returns: Object::Meta - The object which was created or added.

See Method Object::Meta::new()

Consultation Methods

getIndexField ( [ INDEX ] )

This method returns the name of the field that is used to index the instances by the index INDEX.

Parameters:

INDEX

Name of the index. If not given the predefined PRIMARY_INDEXNAME index with name "primary" is used.

Returns: string - The object with the indexed field having the value NAME.

getIdxMetaObject ( INDEX, NAME )

This uses the index of name INDEX to find the Object::Meta object to find the instance.

Parameters:

INDEX

Name of the index.

NAME

The string value for field indexed with the index INDEX of the object.

Returns: Object::Meta - The object with the indexed field having the value NAME.

getMetaObjectCount

This Method gives the Count of Object::Meta objects back that are hold in the List. If the Meta Data Field entrycount is not set it will be created.

Returns: integer - The Count of Object::Meta objects in the List