source: TI03-DataExtractor/branches/old_stuff/dx/doc/cgiInterface_module.txt @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx/doc/cgiInterface_module.txt@793
Revision 793, 1.9 KB checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

  • Property svn:executable set to *
Line 
1Help on module cgiInterface:
2
3NAME
4    cgiInterface
5
6FILE
7    /usr/local/dx-0.1.1/cgiInterface.py
8
9DESCRIPTION
10    CGIInterface.py
11    ===============
12   
13    Output module for the data extractor package delivered via CGI (web).
14   
15    This module holds the CGIInterface class that is used to write HTML
16    output from the data extractor package.
17
18CLASSES
19    CGIInterface
20   
21    class CGIInterface
22     |  CGIInterface class - used to generate interactive output based on user requests
23     |  and available datasets. Typically steps through the following stages:
24     |  1. datasetGroup page
25     |  2. dataset page
26     |  3. variables page
27     |  4. domain page
28     |  Current version only creates HTML output.
29     | 
30     |  Methods defined here:
31     | 
32     |  __init__(self)
33     |      __init__ method - prints the http header.
34     | 
35     |  writeFooter(self, footfile='/usr/local/dx_wv/html/footer.html')
36     |      writeFooter method - writes the footer section present on all
37     |      output pages of the dx.
38     | 
39     |  writeForm(self, request, stage=0)
40     |      Method to write out the main form options for all except the domain page.
41     | 
42     |  writeHeader(self, headfile='/usr/local/dx_wv/html/header.html')
43     |      writeHeader method - writes the header section present on all
44     |      output pages of the dx.
45     | 
46     |  writePage(self, request, stage)
47     |      Method to write the entire page. This calls a number of methods to display
48     |      each part of the page.
49     | 
50     |  writeRequestInfo(self, request, stage=0)
51     |      Method to write out the current request information.
52     | 
53     |  writeResults(self, request)
54     |      Method to tell user that there job is underway with details of their selection.
55     |      Should really make a page to confirm these choices and double confirm if it will
56     |      take a long time.
57
Note: See TracBrowser for help on using the repository browser.