Difference between revisions of "Python Object Classes"

From ISFDB
Jump to navigation Jump to search
(Rework page)
 
Line 1: Line 1:
 +
==Introduction==
 +
The python classes are used to encapsulate different types of bibliographic data, and provide methods for manipulating that data. The editing classes are used to parse data that was entered into the editing forms (and have been encoded in HTML variables), can load data from the database, and can convert data into XML format. The data in the class is a complete collection of information from one of the central database tables, without the need to dereference any foreign keys. The bibliographic classes allow applications to aggregate large amounts of data (like an author's bibliography), and contains methods that allows the bibliography to print itself, or to perform searches based on user filters.
 +
 
==Editing Classes==
 
==Editing Classes==
 
* [[ObjectClass:authors]] - Used to edit author information.
 
* [[ObjectClass:authors]] - Used to edit author information.
 
* [[ObjectClass:awards]] - used to edit award information.
 
* [[ObjectClass:awards]] - used to edit award information.
 +
* [[ObjectClass:interviewEntry]] - used to edit interview information.
 +
* [[ObjectClass:publishers]] - used to edit interview content information.
 +
* [[ObjectClass:pubs]] - used to edit interview information.
 +
* [[ObjectClass:reviewEntry]] - used to edit review content information.
 +
* [[ObjectClass:series]] - used to edit series information
 +
* [[ObjectClass:titleEntry]] - used to edit title content information.
 +
* [[ObjectClass:titles]] - used to edit title information.
  
 
==Bibliographic Classes==
 
==Bibliographic Classes==
  
* [[ObjectClass:Bibliography]] -
+
* [[ObjectClass:Bibliography]] - used to display a particular kind of bibliography.
* [[ObjectClass:ISFDB]] -  
+
* [[ObjectClass:ISFDB]] - used to conduct advance searching.
* [[ObjectClass:Series]] -
+
* [[ObjectClass:Series]] - used to display series information.
 
 
==Bibliography==
 
 
 
Methods:
 
 
 
* loadAuthorData(self, author):
 
* setViewsMode(self):
 
* setAlphaMode(self):
 
* setChronMode(self):
 
* loadAllAuthorTitles(self):
 
* loadAllPseudoTitles(self):
 
* loadLongAuthorTitles(self):
 
* loadShortAuthorTitles(self):
 
* loadSerialTitles(self):
 
* loadAuthorAwards(self):
 
* loadAuthorCollaborators(self):
 
* loadAuthorVariants(self):
 
* loadNCSeriesData(self):
 
* loadASeriesData(self):
 
* loadESeriesData(self):
 
* loadNFSeriesData(self):
 
* loadShortSeriesData(self):
 
* loadEssaySeriesData(self):
 
* selfPseudo(self):
 
* printIsPseudo(self, printLabel):
 
* printHasPseudo(self, printLabel):
 
* printAuthorData(self):
 
* printNCSeries(self):
 
* printASeries(self):
 
* printESeries(self):
 
* printNFSeries(self):
 
* printShortSeries(self):
 
* printEssaySeries(self):
 
* displayWorks(self, type, add_serials = DISPLAY_ADD_SERIALS):
 
* printStrayPubs(self):
 
 
 
==interviewEntry==
 
 
 
Methods:
 
 
 
* setPage(self, page):
 
* setTitle(self, title):
 
* setID(self, id):
 
* setDate(self, date):
 
* setInterviewees(self, authors):
 
* setInterviewers(self, authors):
 
* setOldInterview(self, oldinterview):
 
* xmlTitle(self):
 
* xmlCloneTitle(self):
 
* printTitle(self):
 
 
 
==ISFDB==
 
 
 
Methods:
 
 
 
* SetForm(self, form):
 
* SetPubID(self, pubid):
 
* SetDb(self, db):
 
* GetColumnList(self):
 
* GetValueList(self):
 
* GetChanges(self):
 
* GetStart(self):
 
* SyncTablesNew(self, newtitle, newauthor, newtag, newyear, newctype):
 
* BuildColumnValues(self, target):
 
* HTMLBuildColumnValues(self, target):
 
* updatetable(self, newvar, oldvar, field, label, table):
 
* ExtractTermsFromForm(self, default_order):
 
* ExtractTermsFromCmdline(self):
 
* BuildSearchNow(self):
 
* BuildSearchNext(self):
 
* BuildPubSQL_FromForm(self, form, start):
 
* BuildAuthSQL_FromForm(self, form, start):
 
* BuildTitleSQL_FromForm(self, form, start):
 
* BuildPubSQL_FromCmdline(self):
 
* BuildAuthSQL_FromCmdline(self):
 
* BuildTitleSQL_FromCmdline(self):
 
* updatepub(self, newvar, oldvar, field, label):
 
* updateauth(self, newvar, oldvar, field, label):
 
* updatetitle(self, newvar, oldvar, field, label):
 
* updatenote(self, newnote, oldnote, pubid, label):
 
 
 
==publishers==
 
 
 
Methods:
 
 
 
* load(self, id):
 
* obj2xml(self):
 
* xml2obj(self, xml):
 
* cgi2obj(self):
 
 
 
==pubs==
 
 
 
Methods:
 
 
 
* pushTitle(self, titleEntry):
 
* pushReview(self, reviewEntry):
 
* pushInterview(self, interviewEntry):
 
* xmlContent(self):
 
* xmlCloneContent(self):
 
* printContent(self):
 
* authors(self):
 
* artists(self):
 
* load(self, id):
 
* obj2xml(self):
 
* cgi2obj(self):
 
 
 
==reviewEntry==
 
 
 
Methods:
 
 
 
* setPage(self, page):
 
* setTitle(self, title):
 
* setID(self, id):
 
* setDate(self, date):
 
* setBookAuthors(self, authors):
 
* setReviewers(self, authors):
 
* setOldReview(self, oldreview):
 
* xmlTitle(self):
 
* xmlCloneTitle(self):
 
* printTitle(self):
 
 
 
==series==
 
 
 
Methods:
 
 
 
* load(self, id):
 
* loadXML(self, id):
 
* loadCommon(self, id, doXML):
 
* cgi2obj(self):
 
 
 
==Series==
 
 
 
Methods:
 
 
 
* Print(self, works, nottype, id, collabs, serials, variants, series_type):
 
* AddSeries(self, id, label, parent):
 
* Fixup(self):
 
 
 
==titleEntry==
 
 
 
Methods:
 
 
 
* setPage(self, page):
 
* setTitle(self, title):
 
* setID(self, id):
 
* setDate(self, date):
 
* setType(self, type):
 
* setLength(self, length):
 
* setAuthors(self, authors):
 
* setOldTitle(self, oldtitle):
 
* xmlTitle(self):
 
* xmlCloneTitle(self):
 
* printTitle(self):
 
 
 
==titles==
 
 
 
Methods:
 
 
 
* authors(self):
 
* load(self, id):
 
* loadXML(self, id):
 
* loadCommon(self, id, doXML):
 
* cgi2obj(self):
 

Latest revision as of 19:55, 2 June 2008

Introduction

The python classes are used to encapsulate different types of bibliographic data, and provide methods for manipulating that data. The editing classes are used to parse data that was entered into the editing forms (and have been encoded in HTML variables), can load data from the database, and can convert data into XML format. The data in the class is a complete collection of information from one of the central database tables, without the need to dereference any foreign keys. The bibliographic classes allow applications to aggregate large amounts of data (like an author's bibliography), and contains methods that allows the bibliography to print itself, or to perform searches based on user filters.

Editing Classes

Bibliographic Classes