source: TI03-DataExtractor/branches/old_stuff/dx/doc/request.html @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx/doc/request.html@793
Revision 793, 7.2 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 
1
2<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module request</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>request</strong></big></big></font></td
10><td align=right valign=bottom
11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/dx-0.1.1/request.py">/usr/local/dx-0.1.1/request.py</a></font></td></tr></table>
12    <p><tt>request.py<br>
13===========<br>
14&nbsp;<br>
15Request&nbsp;module&nbsp;for&nbsp;the&nbsp;data&nbsp;extractor&nbsp;package.<br>
16&nbsp;<br>
17This&nbsp;module&nbsp;holds&nbsp;the&nbsp;<a href="#Requestdb">Requestdb</a>&nbsp;class&nbsp;that&nbsp;is&nbsp;used<br>
18to&nbsp;store&nbsp;the&nbsp;contents&nbsp;of&nbsp;user&nbsp;requests.</tt></p>
19<p>
20<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
21<tr bgcolor="#aa55cc">
22<td colspan=3 valign=bottom>&nbsp;<br>
23<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
24   
25<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
26<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
27</td><td width="25%" valign=top><a href="shelve.html">shelve</a><br>
28</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
29<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
30<tr bgcolor="#ee77aa">
31<td colspan=3 valign=bottom>&nbsp;<br>
32<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
33   
34<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
35<td width="100%"><dl>
36<dt><font face="helvetica, arial"><a href="request.html#Requestdb">Requestdb</a>
37</font></dt></dl>
38 <p>
39<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
40<tr bgcolor="#ffc8d8">
41<td colspan=3 valign=bottom>&nbsp;<br>
42<font color="#000000" face="helvetica, arial"><a name="Requestdb">class <strong>Requestdb</strong></a></font></td></tr>
43   
44<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
45<td colspan=2><tt><a href="#Requestdb">Requestdb</a>&nbsp;method&nbsp;-&nbsp;An&nbsp;instance&nbsp;of&nbsp;this&nbsp;holds&nbsp;a&nbsp;user&nbsp;request&nbsp;that<br>
46is&nbsp;stored&nbsp;in&nbsp;a&nbsp;python&nbsp;shelve&nbsp;object.<br>&nbsp;</tt></td></tr>
47<tr><td>&nbsp;</td>
48<td width="100%">Methods defined here:<br>
49<dl><dt><a name="Requestdb-__init__"><strong>__init__</strong></a>(self, request_id<font color="#909090">=None</font>)</dt><dd><tt>__init__&nbsp;method&nbsp;-&nbsp;generates&nbsp;a&nbsp;unique&nbsp;id&nbsp;for&nbsp;a&nbsp;request&nbsp;if&nbsp;the<br>
50requests&nbsp;object&nbsp;does&nbsp;not&nbsp;already&nbsp;exist.</tt></dd></dl>
51
52<dl><dt><a name="Requestdb-getNumDatasets"><strong>getNumDatasets</strong></a>(self)</dt><dd><tt>getNumDatasets&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;current&nbsp;number&nbsp;of&nbsp;datasets<br>
53selected.</tt></dd></dl>
54
55<dl><dt><a name="Requestdb-getRequestID"><strong>getRequestID</strong></a>(self)</dt><dd><tt>getRequestID&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;request&nbsp;ID.</tt></dd></dl>
56
57<dl><dt><a name="Requestdb-loadRequest"><strong>loadRequest</strong></a>(self)</dt><dd><tt>loadRequest&nbsp;method&nbsp;-&nbsp;[not&nbsp;yet&nbsp;implemented]</tt></dd></dl>
58
59<dl><dt><a name="Requestdb-readRequest"><strong>readRequest</strong></a>(self)</dt><dd><tt>readRequest&nbsp;method&nbsp;-&nbsp;reads&nbsp;the&nbsp;current&nbsp;request&nbsp;from&nbsp;the&nbsp;python<br>
60shelve&nbsp;object.</tt></dd></dl>
61
62<dl><dt><a name="Requestdb-saveRequest"><strong>saveRequest</strong></a>(self)</dt><dd><tt>saveRequest&nbsp;method&nbsp;-&nbsp;[not&nbsp;yet&nbsp;implemented]</tt></dd></dl>
63
64<dl><dt><a name="Requestdb-writeRequest"><strong>writeRequest</strong></a>(self, request)</dt><dd><tt>writeRequest&nbsp;method&nbsp;-&nbsp;writes&nbsp;the&nbsp;current&nbsp;request&nbsp;to&nbsp;a&nbsp;python<br>
65shelve&nbsp;object.</tt></dd></dl>
66
67</td></tr></table></td></tr></table><p>
68<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
69<tr bgcolor="#55aa55">
70<td colspan=3 valign=bottom>&nbsp;<br>
71<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
72   
73<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
74<td width="100%"><strong>ADMIN_MAIL_ADDRESS</strong> = 'badc@rl.ac.uk'<br>
75<strong>ADMIN_NOTIFICATION</strong> = 0<br>
76<strong>BASEDIR</strong> = '/usr/local/dx_wv'<br>
77<strong>CDAT_BIN_PATH</strong> = '/usr/local/cdat/bin'<br>
78<strong>CF_METADATA_GLOBAL_ATTRIBUTES</strong> = {'comments': 'Created by test data extractor.'}<br>
79<strong>CGI_NAME</strong> = 'http://localhost/cgi-bin/dxui-0.1.1.py'<br>
80<strong>DATASETS</strong> = {'Test Data Group 1': (('Test Dataset 1', '/usr/local/dx_wv/testdata/testdata1.xml', 'dataset1-unused-code'),), 'Test Data Group 2': (('Test Dataset 2', '/usr/local/dx_wv/testdata/testdata2.xml', 'dataset2-unused-code'),), 'Test Data Group 3': (('Test Dataset 3', '/usr/local/dx_wv/testdata/testdata3.xml', 'dataset3-unused-code'),)}<br>
81<strong>DATASET_GROUPS</strong> = {'Test Data Group 1': None, 'Test Data Group 2': None, 'Test Data Group 3': None}<br>
82<strong>DEBUG</strong> = 1<br>
83<strong>EXTRAS_DIR</strong> = '/dx_extra'<br>
84<strong>HTML_DIR</strong> = '/usr/local/dx_wv/html'<br>
85<strong>HTTP_OUTPUT_DIR</strong> = 'http://localhost/output'<br>
86<strong>LEFT_LOGO</strong> = 'dx_logo.jpg'<br>
87<strong>LOCAL_CGI_NAME</strong> = '/srv/www/cgi-bin/dxui-0.1.1.py'<br>
88<strong>LOCAL_MAIL_HOST</strong> = 'outbox.rl.ac.uk'<br>
89<strong>LOCAL_PYTHONPATH</strong> = ['/usr/local/badcdat/lib', '/usr/local/badcdat/lib/python', '/home/tornado/internal/badc/software/pythonlib/badc', '/usr/local/cdat/lib/python2.3', '/usr/local/cdat/lib/python2.3/site-packages', '/usr/local/cdat/lib/python2.3/site-packages/Numeric']<br>
90<strong>LOCAL_RULES</strong> = 0<br>
91<strong>LOGO_DIR</strong> = '/dx_extra/logos'<br>
92<strong>MAP_APPLET</strong> = '/dx_extra/LiveMap_30/extractorMap.html'<br>
93<strong>MESSAGE_TO_USERS</strong> = 'This is a test version of the Data Extractor so ...error occurs so that we can improve this service.'<br>
94<strong>OUTPUT_DIR</strong> = '/srv/www/htdocs/output'<br>
95<strong>OUTPUT_DIR_PERMISSION</strong> = 488<br>
96<strong>OUTPUT_FILE_GROUP</strong> = 'users'<br>
97<strong>OUTPUT_FILE_PERMISSION</strong> = 416<br>
98<strong>OUTPUT_FILE_USER</strong> = 'wwwrun'<br>
99<strong>OUTPUT_FORMATS</strong> = ['NetCDF']<br>
100<strong>PACKAGE_NAME</strong> = 'Data Extractor'<br>
101<strong>REGISTRATION_PAGE</strong> = 'http://badc.nerc.ac.uk/data/list_all_datasets.html?source=home'<br>
102<strong>REQUEST_DIR</strong> = '/usr/local/dx_wv/requests'<br>
103<strong>REQUEST_SIZE_LIMIT</strong> = 100<br>
104<strong>RESTRICTED_DATA</strong> = 0<br>
105<strong>RIGHT_LOGO</strong> = 'dx_logo.jpg'<br>
106<strong>TIMING_SCALE_FACTOR</strong> = 0.001<br>
107<strong>USER_HOMEDIR</strong> = '/var/lib/wwwrun'<br>
108<strong>VISUALISOR_NAME</strong> = '/cgi-bin/splatui-0.1.1.py'</td></tr></table>
109</body></html>
Note: See TracBrowser for help on using the repository browser.