bazaar.assoc.List

Package bazaar :: Module assoc :: Class List

[show private | hide private]

Type List

               object --+    
                        |    
AssociationReferenceProxy --+
                            |
                           List

Known Subclasses:: BiDirList

Basic descriptor for one-to-many and many-to-many associations.

Method Summary
	`__init__(self, col)` Create descriptor for one-to-many and many-to-many associations.
	`__get__(self, obj, cls)` Descriptor method to get iterator of referenced objects.
	`__set__(self, obj, value)` Assigning list of referenced objects is not implemented yet.
	`addAscData(self, pairs)` Add pair of application object's and referenced object's primary key values into database.
	`append(self, obj, value)` Append referenced object to association.
	`appendKey(self, okey, vkey)` Append referenced object relational data to association data.
	`contains(self, obj, value)` Check if object is referenced by application object.
	`delAscData(self, pairs)` Remove pair of application object's and referenced object's primary key values from database.
	`getAllKeys(self)` Return tuple of application object's and referenced object's primary key values.
	`iterObjects(self, obj)` Return iterator of all referenced objects by application object.
	`justRemove(self, obj, value)` Remove referenced object from association.
	`len(self, obj)` Return amount of all referenced objects by application object.
	`loadData(self)` Load association data from database.
	`reloadData(self, now)` Request reloading association relational data.
	`remove(self, obj, value)` Remove referenced object from association and update information about data removal.
	`saveForeignKey(self, obj, vkey)` Save referenced object's primary key value.
	`update(self, obj)` Update in database relational data of association of given application object.
	`updateableAscData(self, obj, value)` Return pair of application object's and referenced object's primary key values.
Inherited from AssociationReferenceProxy
	`save(self, obj, value)` Assign referenced object.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Instance Variable Summary
	`appended`: Sets of referenced objects appended to association.
	`cache`: Association data cache - sets of referenced objects's primary key values per application object.
	`reload`: If true, then association data will be loaded from database.
	`removed`: Sets of referenced objects removed from association.
Inherited from AssociationReferenceProxy
	`association`: Referenced class' association object of bi-directional association.
	`broker`: Broker of application class.
	`col`: Application object's class attribute.
	`vbroker`: Broker of referenced application objects' class.

Method Details

init(self, col)
(Constructor)

Create descriptor for one-to-many and many-to-many associations.

Parameters:: col - Referenced application object's class column.

Overrides:: bazaar.assoc.AssociationReferenceProxy.__init__

get(self, obj, cls)

Descriptor method to get iterator of referenced objects.

For example, to get list of all referenced objects of specific order ord (items is the descriptor):

   order_item_list = list(ord.items)

or to get a set:

   order_item_set = set(ord.items)

Parameters:: obj - Application object.; cls - Application class.

Returns:: Iterator of referenced objects, when obj is not null, otherwise descriptor object.

See Also: bazaar.assoc.ObjectIterator

set(self, obj, value)

Assigning list of referenced objects is not implemented yet.

addAscData(self, pairs)

Add pair of application object's and referenced object's primary key values into database.

: See Also: update

append(self, obj, value)

Append referenced object to association.

Parameters:: obj - Application object.; value - Referenced object.

appendKey(self, okey, vkey)

Append referenced object relational data to association data.

Parameters:: okey - Application object's primary key value.; vkey - Referenced object's primary key value.

contains(self, obj, value)

Check if object is referenced by application object.

Parameters:: obj - Application object.; value - Object to check.

Returns:: True if object is referenced by application object.

delAscData(self, pairs)

Remove pair of application object's and referenced object's primary key values from database.

: See Also: update

getAllKeys(self)

Return tuple of application object's and referenced object's primary key values.

Referenced object's primary key value is taken from database with appropriate convertor methods.

: See Also: bazaar.motor.Convertor.getAscData

iterObjects(self, obj)

Return iterator of all referenced objects by application object.

Parameters:: obj - Application object.

Returns:: Iterator of all referenced objects.

justRemove(self, obj, value)

Remove referenced object from association.

Parameters:: obj - Application object.; value - Referenced object.

len(self, obj)

Return amount of all referenced objects by application object.

loadData(self)

Load association data from database.

: See Also: reloadData appendKey

reloadData(self, now=False)

Request reloading association relational data.

Association data are removed from memory. If now is set to true, then relationship data are loaded from database immediately.

Parameters:: now - Reload relationship data immediately.

remove(self, obj, value)

Remove referenced object from association and update information about data removal.

Parameters:: obj - Application object.; value - Referenced object.

saveForeignKey(self, obj, vkey)

Save referenced object's primary key value.

Primary key value is appended to the set of referenced objects' primary key values.

Parameters:: obj - Application object.; vkey - Referenced object's primary key value.

Overrides:: bazaar.assoc.AssociationReferenceProxy.saveForeignKey

update(self, obj)

Update in database relational data of association of given application object.

Parameters:: obj - Application object.

updateableAscData(self, obj, value)

Return pair of application object's and referenced object's primary key values.

The data will be used to update relationship in database.

: See Also: update

Instance Variable Details

appended

Sets of referenced objects appended to association.

cache

Association data cache - sets of referenced objects's primary key values per application object.

reload

If true, then association data will be loaded from database.

removed

Sets of referenced objects removed from association.

Generated by Epydoc 2.1 on Tue May 10 18:27:28 2005

http://epydoc.sf.net