| |
- Method resolution order:
- ListAttr
- MiddleKit.Core.Attr.Attr
- MiddleKit.Core.MiddleDict.MiddleDict
- UserDict.UserDict
- MiscUtils.NamedValueAccess.NamedValueAccess
- MiddleKit.Core.ModelObject.ModelObject
Methods defined here:
- __init__(self, dict)
- awakeFromRead(self)
- Check that the target class and backRefAttr actually exist.
- backRefAttrName(self)
- Return the name of the back-reference attribute in the referenced class.
It is necessary to be able to override the default back ref to create
data structures like trees, in which a Middle object might reference
a parent and multiple children, all of the same class as itself.
- className(self)
- Return the name of the base class that this obj ref attribute points to.
Methods inherited from MiddleKit.Core.Attr.Attr:
- isRequired(self)
- Return true if a value is required for this attribute.
In Python, that means the value cannot be None. In relational theory
terms, that means the value cannot be NULL.
- klass(self)
- Return the klass that this attribute is declared in and, therefore, belongs to.
- model(self)
- name(self)
- printWarnings(self, out)
- pyGetName(self)
- Return the name that should be used for the Python "get" accessor method for this attribute.
- pySetName(self)
- Return the name that should be used for the Python "set" accessor method for this attribute.
- setKlass(self, klass)
- Set the klass that the attribute belongs to.
- setting(self, name, default=<class MiscUtils.NoDefault>)
- Return the value of a particular configuration setting taken from the model.
Implementation note: Perhaps a future version should ask the klass and so on up the chain.
Methods inherited from MiddleKit.Core.MiddleDict.MiddleDict:
- boolForKey(self, key, default=False)
- Return True or False for the given key.
Returns False if the key does not even exist.
Raises a value error if the key exists, but cannot be parsed as a bool.
Methods inherited from UserDict.UserDict:
- __cmp__(self, dict)
- __contains__(self, key)
- __delitem__(self, key)
- __getitem__(self, key)
- __len__(self)
- __repr__(self)
- __setitem__(self, key, item)
- clear(self)
- copy(self)
- get(self, key, failobj=None)
- hasValueForKey = _UserDict_hasValueForKey(self, key)
- has_key(self, key)
- items(self)
- iteritems(self)
- iterkeys(self)
- itervalues(self)
- keys(self)
- pop(self, key, *args)
- popitem(self)
- setdefault(self, key, failobj=None)
- update(*args, **kwargs)
- valueForKey = _UserDict_valueForKey(self, key, default=<class MiscUtils.NoDefault>)
- values(self)
Class methods inherited from UserDict.UserDict:
- fromkeys(cls, iterable, value=None) from __builtin__.classobj
Data and other attributes inherited from UserDict.UserDict:
- __hash__ = None
Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess:
- handleUnknownSetKey(self, key)
- hasValueForName(self, keysString)
- Check whether name is available.
- resetKeyBindings(self)
- Rest all key bindings, releasing alreaedy referenced values.
- setValueForKey(self, key, value)
- Set value for a given key.
Suppose key is 'foo'.
This method sets the value with the following precedence:
1. Public attributes before private attributes
2. Methods before non-methods
More specifically, this method then uses one of the following:
@@ 2000-03-04 ce: fill in
... or invokes handleUnknownSetKey().
- valueForKeySequence(self, listOfKeys, default=None)
- Get the value for the given list of keys.
- valueForName(self, keysString, default=None)
- Get the value for the given keysString.
This is the more advanced version of valueForKey(), which can only
handle single names. This method can handle
'foo', 'foo1.foo2', 'a.b.c.d', etc.
It will traverse dictionaries if needed.
- valueForUnknownKey(self, key, default)
- valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0)
- Get all values for given names.
Returns a list of values that match the given keys, each of which is
passed through valueForName() and so could be of the form 'a.b.c'.
keys and defaults are sequences.
default is any kind of object.
forgive and includeNames are flags.
If default is not None, then it is substituted when a key is not found.
Otherwise, if defaults is not None, then its corresponding/parallel
value for the current key is substituted when a key is not found.
Otherwise, if forgive is true, then unknown keys simply don't produce
any values.
Otherwise, if default and defaults are None, and forgive is false,
then the unknown keys will probably raise an exception through
self.valueForUnknownKey() although that method can always return
a final, default value.
if keys is None, then None is returned.
If keys is an empty list, then None is returned.
Often these last four arguments are specified by key.
Examples:
names = ['origin.x', 'origin.y', 'size.width', 'size.height']
obj.valuesForNames(names)
obj.valuesForNames(names, default=0.0)
obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0])
obj.valuesForNames(names, forgive=0)
@@ 2000-03-04 ce: includeNames is only supported when forgive=1.
It should be supported for the other cases.
It should be documented.
It should be included in the test cases.
Methods inherited from MiddleKit.Core.ModelObject.ModelObject:
- printAttrs(self, out=None)
|