Public Member Functions | Public Attributes | List of all members
bp_docdb.Document Class Reference

Public Member Functions

def __init__ (self, id, rev, modtime, authors, first_author_id, first_author, submitter_id, submitter, modifygroup, categories, files, title, abstract, is_blessed, is_dep)
 

Public Attributes

 id
 
 rev
 
 modtime
 
 authors
 
 first_author_id
 
 first_author
 
 submitter_id
 
 submitter
 
 modifygroup
 
 categories
 
 files
 
 title
 
 abstract
 
 is_blessed
 
 is_dep
 

Detailed Description

A class representing a single DocDB document

All relevant metadata associated with a single DocDB document will be
stored in a member of this class.

Note:
    The data members "author_id" and "author", may seem redundant, but
    there is no way to query DocDB for the full author name given an ID, so
    we need to collect both pieces of information here.

Attributes:
    id (int)           : DocDB ID
    rev (int)          : Revision number
    modtime (str)      : Last modified datetime (in CT, presumably)
    author_id (int)    : Author DocDB ID
    author (str)       : Author full name
    submitter_id (int) : Submitter DocDB ID
    submitter (str)    : Submitter full name
    modifygroup (str)    : Name of group with view permissions for this doc
    categories (array) : List of categories (str) applied to document
    files (array)      : List of files attached to document
    title (str)        : Title
    abstract (str)     : Description

Definition at line 17 of file bp_docdb.py.

Constructor & Destructor Documentation

def bp_docdb.Document.__init__ (   self,
  id,
  rev,
  modtime,
  authors,
  first_author_id,
  first_author,
  submitter_id,
  submitter,
  modifygroup,
  categories,
  files,
  title,
  abstract,
  is_blessed,
  is_dep 
)

Definition at line 43 of file bp_docdb.py.

Referenced by PandAna.core.core.spectrum.fill().

43  def __init__(self, id, rev, modtime, authors, first_author_id, first_author, submitter_id, submitter, modifygroup, categories, files, title, abstract, is_blessed, is_dep):
44  self.id = id
45  self.rev = rev
46  self.modtime = modtime
47  self.authors = authors
48  self.first_author_id = first_author_id
49  self.first_author = first_author
50  self.submitter_id = submitter_id
51  self.submitter = submitter
52  self.modifygroup = modifygroup
53  self.categories = categories
54  self.files = files
55  self.title = title
56  self.abstract = abstract
57  self.is_blessed = is_blessed
58  self.is_dep = is_dep
59 
60 
61 # NOTE: Many of the functions contained within this class execute a HTTP
62 # request to DocDB. This process involves two-way communication and can
63 # be relatively slow. Attempting to minimize the number of times an HTTP call
64 # is made is advised when using this class in a program.
def __init__(self, id, rev, modtime, authors, first_author_id, first_author, submitter_id, submitter, modifygroup, categories, files, title, abstract, is_blessed, is_dep)
Definition: bp_docdb.py:43

Member Data Documentation

bp_docdb.Document.abstract

Definition at line 56 of file bp_docdb.py.

bp_docdb.Document.authors

Definition at line 47 of file bp_docdb.py.

bp_docdb.Document.categories
bp_docdb.Document.files
bp_docdb.Document.first_author

Definition at line 49 of file bp_docdb.py.

bp_docdb.Document.first_author_id

Definition at line 48 of file bp_docdb.py.

bp_docdb.Document.id

Definition at line 44 of file bp_docdb.py.

bp_docdb.Document.is_blessed

Definition at line 57 of file bp_docdb.py.

bp_docdb.Document.is_dep

Definition at line 58 of file bp_docdb.py.

bp_docdb.Document.modifygroup

Definition at line 52 of file bp_docdb.py.

bp_docdb.Document.modtime

Definition at line 46 of file bp_docdb.py.

bp_docdb.Document.rev

Definition at line 45 of file bp_docdb.py.

bp_docdb.Document.submitter

Definition at line 51 of file bp_docdb.py.

bp_docdb.Document.submitter_id

Definition at line 50 of file bp_docdb.py.

bp_docdb.Document.title

The documentation for this class was generated from the following file: