Modeling.interfaces.Adaptor

Package Modeling :: Package interfaces :: Module Adaptor

[show private | hide private]

Module Modeling.interfaces.Adaptor

Adaptor API

__TBD: general presentation

__TBD: Adaptor.Delegate

How are concrete Adaptors loaded?

...

Implementing an adaptor

module: naming conventions

module: should have a function named 'adaptorFactory'

class: see below

Exceptions: AdaptorImportError, GeneralAdaptorException

CVS information

$Id: Adaptor.py,v 1.5 2004/07/20 06:21:40 sbigaret Exp $

Classes
`Base`
`IAdaptor`	Implemented in base class:...

Function Summary
	`adaptorWithModel(aModel)` Returns the adaptor associated to the supplied model: it extracts the name of the adaptor to be used with the model then calls adaptorWithModel() Raises ValueError is parameter 'aModel' is None or if its adaptorName is empty.
	`adaptorWithName(aName)` Returns the adaptor.
	`defaultDelegate()` Returns the default delegate.
	`expressionClassForAdaptor(adaptor)` Returns the expression class to be used by adaptor, or None if none was previously set with 'setExpressionClassForAdaptor()'.
	`setDefaultDelegate(delegate)` Sets the default delegate which is assigned to Adaptor instances when they are initialized.
	`setExpressionClassForAdaptor(sqlExpression, adaptor)` Sets the SQLExpression to use in conjonction with a particular adaptor.

Function Details

adaptorWithModel(aModel)

Returns the adaptor associated to the supplied model: it extracts the name of the adaptor to be used with the model then calls adaptorWithModel() Raises ValueError is parameter 'aModel' is None or if its adaptorName is empty. Raises AdaptorImportError if the adaptor cannot be loaded.

adaptorWithName(aName)

Returns the adaptor. Raises AdaptorImportError if the adaptor cannot be loaded.

defaultDelegate()

Returns the default delegate. See: setDefaultDelegate()

expressionClassForAdaptor(adaptor)

Returns the expression class to be used by adaptor, or None if none was previously set with 'setExpressionClassForAdaptor()'.

setDefaultDelegate(delegate)

Sets the default delegate which is assigned to Adaptor instances when they are initialized.

setExpressionClassForAdaptor(sqlExpression, adaptor)

Sets the SQLExpression to use in conjonction with a particular adaptor. Parameters 'sqlExpression' and 'adaptor' can be either instances or classes.

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

http://epydoc.sf.net