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

Class CGIDB

RegisterableObject --+    
                     |    
              DBObject --+
                         |
         TextLikeMixin --+
                         |
                        CGIDB


This class implements DBObject for accessing CGI databases.
Method Summary
  __init__(self, name, cgi, url, key, params, abbrev, doc, delay, timeout, getmethod, failure_cases)
CGIDB(name, cgi[, url][, key][, params][, abbrev][, doc] [, delay][, timeout][, getmethod][, failure_cases])
  _cgiopen(self, key)
  _get(self, key)
S._get(key) -> data
  _make_pickleable(self, handle)
  _normalize_params(self, key)
  _unmake_pickleable(self, obj)
    Inherited from DBObject
  __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
  _set(self, key, data)
S._set(key, data)
    Inherited from TextLikeMixin
  _check_for_errors(self, handle, failure_cases)

Method Details

__init__(self, name, cgi, url=None, key=None, params=None, abbrev=None, doc=None, delay=None, timeout=None, getmethod=1, failure_cases=None)
(Constructor)

CGIDB(name, cgi[, url][, key][, params][, abbrev][, doc] [, delay][, timeout][, getmethod][, failure_cases])

name is the name of the object, abbrev is an abbreviation for the name, and doc is some documentation describing the object.

cgi is the URL for the cgi script. url points to the human-readable URL of the form.

params is a list of (key, value) tuples indicating the parameters that should be passed to the CGI script. key is the name of the parameter for the CGI script whose value is the ID of the object to retrieve.

getmethod is a boolean describing whether a GET or POST should be used. By default, GET is used.

failure_cases is a list of (Martel Expression, error message) describing patterns of errors in the text returned by the script.
Overrides:
Bio.config.DBRegistry.DBObject.__init__

_get(self, key)

S._get(key) -> data
Overrides:
Bio.config.DBRegistry.DBObject._get (inherited documentation)

Generated by Epydoc 2.1 on Wed Jan 31 09:58:01 2007 http://epydoc.sf.net