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

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

Put all the old code in the old_stuff branch.

Line 
1
2<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module datasetdb</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>datasetdb</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/datasetdb.py">/usr/local/dx-0.1.1/datasetdb.py</a></font></td></tr></table>
12    <p><tt>datasets.py<br>
13===========<br>
14&nbsp;<br>
15Datasets&nbsp;module&nbsp;for&nbsp;the&nbsp;dx&nbsp;package.<br>
16&nbsp;<br>
17This&nbsp;module&nbsp;holds&nbsp;the&nbsp;<a href="#Datasetdb">Datasetdb</a>&nbsp;class&nbsp;that&nbsp;is&nbsp;used<br>
18to&nbsp;hold&nbsp;and&nbsp;access&nbsp;information&nbsp;about&nbsp;datasets&nbsp;visible<br>
19to&nbsp;the&nbsp;dx&nbsp;package.</tt></p>
20<p>
21<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
22<tr bgcolor="#aa55cc">
23<td colspan=3 valign=bottom>&nbsp;<br>
24<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
25   
26<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
27<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="cdms.html">cdms</a><br>
28<a href="cdtime.html">cdtime</a><br>
29</td><td width="25%" valign=top><a href="os.html">os</a><br>
30<a href="re.html">re</a><br>
31</td><td width="25%" valign=top><a href="shelve.html">shelve</a><br>
32</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
33<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
34<tr bgcolor="#ee77aa">
35<td colspan=3 valign=bottom>&nbsp;<br>
36<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
37   
38<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
39<td width="100%"><dl>
40<dt><font face="helvetica, arial"><a href="datasetdb.html#Datasetdb">Datasetdb</a>
41</font></dt></dl>
42 <p>
43<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
44<tr bgcolor="#ffc8d8">
45<td colspan=3 valign=bottom>&nbsp;<br>
46<font color="#000000" face="helvetica, arial"><a name="Datasetdb">class <strong>Datasetdb</strong></a></font></td></tr>
47   
48<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
49<td colspan=2><tt><a href="#Datasetdb">Datasetdb</a>&nbsp;class&nbsp;-&nbsp;a&nbsp;group&nbsp;of&nbsp;methods&nbsp;to&nbsp;connect&nbsp;to&nbsp;a&nbsp;dataset&nbsp;group&nbsp;or<br>
50dataset&nbsp;to&nbsp;extract&nbsp;information&nbsp;about&nbsp;the&nbsp;contents.<br>&nbsp;</tt></td></tr>
51<tr><td>&nbsp;</td>
52<td width="100%">Methods defined here:<br>
53<dl><dt><a name="Datasetdb-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>__init__&nbsp;method&nbsp;-&nbsp;set&nbsp;up&nbsp;instance&nbsp;variables.</tt></dd></dl>
54
55<dl><dt><a name="Datasetdb-getCFGlobalAttributes"><strong>getCFGlobalAttributes</strong></a>(self, datafile)</dt><dd><tt>getCFGlobalAttributes&nbsp;method&nbsp;-&nbsp;gets&nbsp;any&nbsp;CF&nbsp;metadta&nbsp;global&nbsp;attributes&nbsp;that&nbsp;are&nbsp;available<br>
56from&nbsp;the&nbsp;source&nbsp;dataset/file.</tt></dd></dl>
57
58<dl><dt><a name="Datasetdb-getDatasetGroupFromURI"><strong>getDatasetGroupFromURI</strong></a>(self, datasetURI)</dt><dd><tt>getDatasetGroupFromURI&nbsp;method&nbsp;-&nbsp;gets&nbsp;the&nbsp;id&nbsp;of&nbsp;the&nbsp;dataset&nbsp;group&nbsp;from&nbsp;a<br>
59datasetURI&nbsp;(if&nbsp;it&nbsp;is&nbsp;known&nbsp;to&nbsp;the&nbsp;dx).</tt></dd></dl>
60
61<dl><dt><a name="Datasetdb-getDatasetGroups"><strong>getDatasetGroups</strong></a>(self)</dt><dd><tt>getDatasetGroups&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;dataset&nbsp;groups&nbsp;that&nbsp;the&nbsp;dx&nbsp;knows&nbsp;about.</tt></dd></dl>
62
63<dl><dt><a name="Datasetdb-getDatasetURIList"><strong>getDatasetURIList</strong></a>(self)</dt><dd><tt>getDatasetURILList&nbsp;method&nbsp;-&nbsp;gets&nbsp;a&nbsp;list&nbsp;of&nbsp;all&nbsp;the&nbsp;datasetURIs&nbsp;visible<br>
64to&nbsp;this&nbsp;version&nbsp;of&nbsp;dx&nbsp;(in&nbsp;the&nbsp;config.py&nbsp;file).</tt></dd></dl>
65
66<dl><dt><a name="Datasetdb-getDatasets"><strong>getDatasets</strong></a>(self, datasetGroup)</dt><dd><tt>getDatasets&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;datasets&nbsp;associated&nbsp;with&nbsp;the&nbsp;dataset&nbsp;group<br>
67argument.</tt></dd></dl>
68
69<dl><dt><a name="Datasetdb-getDomain"><strong>getDomain</strong></a>(self, datasetGroup<font color="#909090">=None</font>, dataset<font color="#909090">=None</font>, variable<font color="#909090">=None</font>, datasetURI<font color="#909090">=None</font>)</dt><dd><tt>getDomain&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;combined&nbsp;horizontal,&nbsp;vertical&nbsp;and&nbsp;temporal&nbsp;domains.</tt></dd></dl>
70
71<dl><dt><a name="Datasetdb-getHorizontalSpatialDomain"><strong>getHorizontalSpatialDomain</strong></a>(self, datasetGroup<font color="#909090">=None</font>, dataset<font color="#909090">=None</font>, variable<font color="#909090">=None</font>, datasetURI<font color="#909090">=None</font>)</dt></dl>
72
73<dl><dt><a name="Datasetdb-getProtectID"><strong>getProtectID</strong></a>(datasetGroup<font color="#909090">=None</font>, datasetURI<font color="#909090">=None</font>)</dt><dd><tt>getProtectID&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;security&nbsp;group&nbsp;for&nbsp;a&nbsp;given&nbsp;dataset&nbsp;group&nbsp;or<br>
74datasetURI&nbsp;(if&nbsp;known&nbsp;to&nbsp;the&nbsp;dx).</tt></dd></dl>
75
76<dl><dt><a name="Datasetdb-getTemporalDomain"><strong>getTemporalDomain</strong></a>(self, datasetGroup<font color="#909090">=None</font>, dataset<font color="#909090">=None</font>, variable<font color="#909090">=None</font>, datasetURI<font color="#909090">=None</font>)</dt><dd><tt>getTemporalDomain&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;temporal&nbsp;domain&nbsp;as&nbsp;a&nbsp;tuple&nbsp;of&nbsp;(start&nbsp;time,&nbsp;end&nbsp;time,&nbsp;<br>
77(interval&nbsp;value,&nbsp;interval&nbsp;units)).</tt></dd></dl>
78
79<dl><dt><a name="Datasetdb-getVariables"><strong>getVariables</strong></a>(self, datasetGroup<font color="#909090">=None</font>, dataset<font color="#909090">=None</font>, datasetURI<font color="#909090">=None</font>)</dt><dd><tt>getVariables&nbsp;method&nbsp;-&nbsp;returns&nbsp;a&nbsp;list&nbsp;of&nbsp;variables&nbsp;ior&nbsp;the&nbsp;given&nbsp;dataset<br>
80group/dataset&nbsp;combination&nbsp;or&nbsp;datasetURI.&nbsp;The&nbsp;variable&nbsp;name&nbsp;used&nbsp;is&nbsp;selected<br>
81hierarchically&nbsp;depending&nbsp;on&nbsp;the&nbsp;available&nbsp;attributes.</tt></dd></dl>
82
83<dl><dt><a name="Datasetdb-getVerticalSpatialDomain"><strong>getVerticalSpatialDomain</strong></a>(self, datasetGroup<font color="#909090">=None</font>, dataset<font color="#909090">=None</font>, variable<font color="#909090">=None</font>, datasetURI<font color="#909090">=None</font>)</dt><dd><tt>getVerticalSpatialDomain&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;vertical&nbsp;domain&nbsp;as&nbsp;a&nbsp;tuple&nbsp;containing<br>
84a&nbsp;list&nbsp;of&nbsp;levels&nbsp;(or&nbsp;"Single&nbsp;level"&nbsp;string)&nbsp;and&nbsp;the&nbsp;units.</tt></dd></dl>
85
86</td></tr></table></td></tr></table><p>
87<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
88<tr bgcolor="#55aa55">
89<td colspan=3 valign=bottom>&nbsp;<br>
90<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
91   
92<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
93<td width="100%"><strong>ADMIN_MAIL_ADDRESS</strong> = 'badc@rl.ac.uk'<br>
94<strong>ADMIN_NOTIFICATION</strong> = 0<br>
95<strong>BASEDIR</strong> = '/usr/local/dx_wv'<br>
96<strong>CDAT_BIN_PATH</strong> = '/usr/local/cdat/bin'<br>
97<strong>CF_METADATA_GLOBAL_ATTRIBUTES</strong> = {'comments': 'Created by test data extractor.'}<br>
98<strong>CGI_NAME</strong> = 'http://localhost/cgi-bin/dxui-0.1.1.py'<br>
99<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>
100<strong>DATASET_GROUPS</strong> = {'Test Data Group 1': None, 'Test Data Group 2': None, 'Test Data Group 3': None}<br>
101<strong>DEBUG</strong> = 1<br>
102<strong>EXTRAS_DIR</strong> = '/dx_extra'<br>
103<strong>HTML_DIR</strong> = '/usr/local/dx_wv/html'<br>
104<strong>HTTP_OUTPUT_DIR</strong> = 'http://localhost/output'<br>
105<strong>LEFT_LOGO</strong> = 'dx_logo.jpg'<br>
106<strong>LOCAL_CGI_NAME</strong> = '/srv/www/cgi-bin/dxui-0.1.1.py'<br>
107<strong>LOCAL_MAIL_HOST</strong> = 'outbox.rl.ac.uk'<br>
108<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>
109<strong>LOCAL_RULES</strong> = 0<br>
110<strong>LOGO_DIR</strong> = '/dx_extra/logos'<br>
111<strong>MAP_APPLET</strong> = '/dx_extra/LiveMap_30/extractorMap.html'<br>
112<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>
113<strong>OUTPUT_DIR</strong> = '/srv/www/htdocs/output'<br>
114<strong>OUTPUT_DIR_PERMISSION</strong> = 488<br>
115<strong>OUTPUT_FILE_GROUP</strong> = 'users'<br>
116<strong>OUTPUT_FILE_PERMISSION</strong> = 416<br>
117<strong>OUTPUT_FILE_USER</strong> = 'wwwrun'<br>
118<strong>OUTPUT_FORMATS</strong> = ['NetCDF']<br>
119<strong>PACKAGE_NAME</strong> = 'Data Extractor'<br>
120<strong>REGISTRATION_PAGE</strong> = 'http://badc.nerc.ac.uk/data/list_all_datasets.html?source=home'<br>
121<strong>REQUEST_DIR</strong> = '/usr/local/dx_wv/requests'<br>
122<strong>REQUEST_SIZE_LIMIT</strong> = 100<br>
123<strong>RESTRICTED_DATA</strong> = 0<br>
124<strong>RIGHT_LOGO</strong> = 'dx_logo.jpg'<br>
125<strong>TIMING_SCALE_FACTOR</strong> = 0.001<br>
126<strong>USER_HOMEDIR</strong> = '/var/lib/wwwrun'<br>
127<strong>VISUALISOR_NAME</strong> = '/cgi-bin/splatui-0.1.1.py'</td></tr></table>
128</body></html>
Note: See TracBrowser for help on using the repository browser.