Modeling.ClassDescription.ClassDescription

Package Modeling :: Module ClassDescription :: Class ClassDescription

[show private | hide private]

Type ClassDescription

object --+
         |
        ClassDescription

Known Subclasses:: EntityClassDescription

This class is an abstract class ; all methods defined in ClassDescriptionInterface raises and should be overridden in concrete subclasses.

Please refer to ClassDescriptionInterface for documentation.

Method Summary
	`adaptorName(self)`
	`attributesKeys(self)`
	`awakeObjectFromFetch(self, object, editingContext)` __TBD Currently does nothing.
	`awakeObjectFromInsertion(self, object, editingContext)` __TBD Currently does nothing.
	`classDescriptionForDestinationKey(self, aKey)`
	`classDescriptionForName(name)` Returns the ClassDescription corresponding to name (Static method)
	`classDescriptionForObject(anObject)` Returns the ClassDescription associated to the object 'anObject' (Static method)
	`createInstanceWithEditingContext(self, editingContext)`
	`delegate(self)` See interfaces.ClassDescription for details
	`deleteRuleForRelationshipKey(self, aKey)`
	`displayNameForKey(self, aKey)`
	`entityName(self)`
	`foreignKeys(self)`
	`invalidateClassDescriptionCache()` Simply empties the set of held class description (Static method)
	`inverseForRelationshipKey(self, aKey)`
	`primaryKeys(self)`
	`propagateDeleteForObject(self, anObject, editingContext)`
	`propagateInsertionForObject(self, anObject, editingContext)` Examines the object's relationships and searches for related objects not inserted in 'editingContext', then inserts these objects into editingContextif they are not already registered.
	`registerClassDescription(aClassDescription, name)` Assigns the supplied classDescription to 'name'. (Static method)
	`registeredNames()` Returns the registered names (Static method)
	`registerProvider(self, aProvider)`
	`setDelegate(self, aDelegate)` See interfaces.ClassDescription for details
	`toManyRelationshipKeys(self)`
	`toOneRelationshipKeys(self)`
	`userPresentableDescriptionForObject(self, anObject)`
	`validateObjectForDelete(self, anObject)`
	`validateObjectForSave(self, anObject)`
	`validateValueForKey(self, anObject, aValue, aKey)`
	`XMLDescriptionForObject(self, anObject)`
Inherited from object
	`__init__(...)` x.__init__(...) initializes x; see x.__class__.__doc__ for signature
	`__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)

Class Variable Summary
`tuple`	`__implements__` = `(<class Modeling.interfaces.ClassDescri...`
`NoneType`	`_delegate` = None

Instance Method Details

awakeObjectFromFetch(self, object, editingContext)

__TBD Currently does nothing.

Subclasses overriding this method should call this method before proceeding

awakeObjectFromInsertion(self, object, editingContext)

__TBD Currently does nothing.

Subclasses overriding this method should call this method before proceeding

delegate(self)

See interfaces.ClassDescription for details

propagateInsertionForObject(self, anObject, editingContext)

Examines the object's relationships and searches for related objects not inserted in 'editingContext', then inserts these objects into editingContextif they are not already registered.

This is normally called when an EditingContext gets the processRecentChanges() message.

Subclasses must override this method without calling it.

setDelegate(self, aDelegate)

See interfaces.ClassDescription for details

Static Method Details

classDescriptionForName(name)

Returns the ClassDescription corresponding to name

If the requested class description cannot be found, this method posts a 'ClassDescriptionNeededForEntityNameNotification' so that listeners can register the apropriate class description --in a standard confioguration, the default ModelSet listens to that notification and registers the class descriptions each time they are needed.

classDescriptionForObject(anObject)

Returns the ClassDescription associated to the object 'anObject'

invalidateClassDescriptionCache()

Simply empties the set of held class description

registerClassDescription(aClassDescription, name)

Assigns the supplied classDescription to 'name'.

The supplied ClassDescription's simple methods are not cached, unless MDL_ENABLE_SIMPLE_METHOD_CACHE is set to any non-empty string. See utils.cache_simple_methods() for details.

registeredNames()

Returns the registered names

Class Variable Details

implements

Type:: tuple
Value:: (<class Modeling.interfaces.ClassDescription.ClassDescriptionInterface\ at 0xb788c3ec>,)

_delegate

Type:: NoneType
Value:: None

Generated by Epydoc 2.1 on Sat Mar 4 13:36:21 2006

http://epydoc.sf.net