Package Bio :: Package config :: Module DBRegistry :: Class DBObject
[show private | hide private]
[frames | no frames]

Class DBObject

RegisterableObject --+
                     |
                    DBObject

Known Subclasses:
BioCorbaDB, BioSQLDB, CGIDB, EUtilsDB, IndexedFileDB

This is a base class for dictionary-like interfaces to
databases.

Methods:
get                  Lookup a key in a database, with a default value.
get_as               Lookup a key and convert to an object.
__getitem__          Lookup a key in a database.

    THE FOLLOWING SHOULD BE IMPLEMENTED IN A DERIVED CLASS.
_get                 Return the data indicated by key.
_convert_to          Convert the data to another object.
    IMPLEMENT THESE ONLY IF TIMEOUT OR CONCURRENT ACCESS IS NEEDED.
_make_pickleable     Make the object returned by _get to a pickleable.
_unmake_pickleable   Turn the pickleable object back into the original

Method Summary
  __init__(self, name, abbrev, doc, delay, timeout)
DBObject(name[, abbrev][, doc][, delay][, timeout])
  __getitem__(self, key)
  get(self, key, default)
S.get(key[, default]) -> data
  get_as(self, key, to_io, default)
S.get_as(key[, to_io][, default]) -> object
  set(self, key, data)
  _convert_to(self, data, to_io)
S._convert_to(data, to_io) -> another data type
  _get(self, key)
S._get(key) -> data
  _make_pickleable(self, data)
S._make_pickleable(key, data) -> pickleable_obj
  _set(self, key, data)
S._set(key, data)
  _unmake_pickleable(self, pickleable_obj)
S._unmake_pickleable(key, pickleable_obj) -> data

Method Details

__init__(self, name, abbrev=None, doc=None, delay=None, timeout=None)
(Constructor)

DBObject(name[, abbrev][, doc][, delay][, timeout])
Overrides:
Bio.config.Registry.RegisterableObject.__init__

get(self, key, default=None)

S.get(key[, default]) -> data

get_as(self, key, to_io=None, default=None)

S.get_as(key[, to_io][, default]) -> object

_convert_to(self, data, to_io)

S._convert_to(data, to_io) -> another data type

_get(self, key)

S._get(key) -> data

_make_pickleable(self, data)

S._make_pickleable(key, data) -> pickleable_obj

_set(self, key, data)

S._set(key, data)

_unmake_pickleable(self, pickleable_obj)

S._unmake_pickleable(key, pickleable_obj) -> data

Generated by Epydoc 2.1 on Sat Jul 16 15:49:00 2005 http://epydoc.sf.net