source: TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/dxrmlHandler.html @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/dxrmlHandler.html@793
Revision 793, 5.8 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 dxrmlHandler</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>dxrmlHandler</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/dxrmlHandler.py">/usr/local/dx-0.1.1/dxrmlHandler.py</a></font></td></tr></table>
12    <p><tt>dxrmlHandler.py<br>
13===============<br>
14&nbsp;<br>
15Holds&nbsp;the&nbsp;DXRMLHandler&nbsp;class&nbsp;for&nbsp;parsing&nbsp;and&nbsp;writing&nbsp;the<br>
16Data&nbsp;Extractor's&nbsp;Request&nbsp;Markup&nbsp;Language&nbsp;(DXRML).</tt></p>
17<p>
18<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
19<tr bgcolor="#aa55cc">
20<td colspan=3 valign=bottom>&nbsp;<br>
21<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
22   
23<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
24<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="xml.dom.minidom.html">xml.dom.minidom</a><br>
25</td><td width="25%" valign=top><a href="re.html">re</a><br>
26</td><td width="25%" valign=top><a href="xml.sax.saxutils.html">xml.sax.saxutils</a><br>
27</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
28<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
29<tr bgcolor="#ee77aa">
30<td colspan=3 valign=bottom>&nbsp;<br>
31<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
32   
33<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
34<td width="100%"><dl>
35<dt><font face="helvetica, arial"><a href="dxrmlHandler.html#DXRMLGenerator">DXRMLGenerator</a>
36</font></dt><dt><font face="helvetica, arial"><a href="dxrmlHandler.html#DXRMLParser">DXRMLParser</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="DXRMLGenerator">class <strong>DXRMLGenerator</strong></a></font></td></tr>
43   
44<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
45<td colspan=2><tt>Class&nbsp;to&nbsp;produce&nbsp;a&nbsp;dxrml&nbsp;output&nbsp;string&nbsp;based&nbsp;on&nbsp;a&nbsp;dx&nbsp;request&nbsp;dictionary.<br>&nbsp;</tt></td></tr>
46<tr><td>&nbsp;</td>
47<td width="100%">Methods defined here:<br>
48<dl><dt><a name="DXRMLGenerator-__init__"><strong>__init__</strong></a>(self, requestDict)</dt><dd><tt>Takes&nbsp;in&nbsp;a&nbsp;request&nbsp;dictionary&nbsp;object.</tt></dd></dl>
49
50<dl><dt><a name="DXRMLGenerator-writeToFile"><strong>writeToFile</strong></a>(self, filename)</dt><dd><tt>Writes&nbsp;the&nbsp;XML&nbsp;file&nbsp;content&nbsp;to&nbsp;an&nbsp;actual&nbsp;output&nbsp;file.</tt></dd></dl>
51
52</td></tr></table> <p>
53<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
54<tr bgcolor="#ffc8d8">
55<td colspan=3 valign=bottom>&nbsp;<br>
56<font color="#000000" face="helvetica, arial"><a name="DXRMLParser">class <strong>DXRMLParser</strong></a></font></td></tr>
57   
58<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
59<td colspan=2><tt>Parser&nbsp;class&nbsp;for&nbsp;DXRML&nbsp;files&nbsp;into&nbsp;a&nbsp;python&nbsp;request&nbsp;dictionary.<br>
60The&nbsp;resulting&nbsp;dictionary&nbsp;has&nbsp;a&nbsp;flat&nbsp;content&nbsp;and&nbsp;can&nbsp;be&nbsp;passed<br>
61directly&nbsp;into&nbsp;the&nbsp;dx&nbsp;as&nbsp;a&nbsp;request.<br>&nbsp;</tt></td></tr>
62<tr><td>&nbsp;</td>
63<td width="100%">Methods defined here:<br>
64<dl><dt><a name="DXRMLParser-__getattr__"><strong>__getattr__</strong></a>(self, attr)</dt><dd><tt>For&nbsp;dictionary&nbsp;access&nbsp;to&nbsp;the&nbsp;instance&nbsp;object.</tt></dd></dl>
65
66<dl><dt><a name="DXRMLParser-__init__"><strong>__init__</strong></a>(self, xmlfile)</dt><dd><tt>Method&nbsp;to&nbsp;take&nbsp;in&nbsp;the&nbsp;xml&nbsp;file&nbsp;and&nbsp;call&nbsp;relevant&nbsp;methods<br>
67to&nbsp;parse&nbsp;the&nbsp;content&nbsp;into&nbsp;a&nbsp;dictionary.</tt></dd></dl>
68
69<dl><dt><a name="DXRMLParser-getDictionary"><strong>getDictionary</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;dictionary&nbsp;object&nbsp;created&nbsp;from&nbsp;an&nbsp;XML&nbsp;file.</tt></dd></dl>
70
71</td></tr></table></td></tr></table><p>
72<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
73<tr bgcolor="#55aa55">
74<td colspan=3 valign=bottom>&nbsp;<br>
75<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
76   
77<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
78<td width="100%"><strong>MAX_NUM_DATASETS</strong> = 2<br>
79<strong>perDatasetItems</strong> = [['request', 'dxDatasets', 'dxDataset', 'datasetGroup'], ['request', 'dxDatasets', 'dxDataset', 'dataset'], ['request', 'dxDatasets', 'dxDataset', 'datasetURI'], ['request', 'dxDatasets', 'dxDataset', 'variable'], ['request', 'dxDatasets', 'dxDataset', 'verticalDomain'], ['request', 'dxDatasets', 'dxDataset', 'startDateTime'], ['request', 'dxDatasets', 'dxDataset', 'endDateTime'], ['request', 'dxDatasets', 'dxDataset', 'timeIntervalValue'], ['request', 'dxDatasets', 'dxDataset', 'timeIntervalUnits']]<br>
80<strong>singleItems</strong> = [['request', 'numberOfDatasets'], ['request', 'outputFormat'], ['request', 'useMultipleOutputFiles'], ['request', 'horizontalDomain', 'northernExtent'], ['request', 'horizontalDomain', 'southernExtent'], ['request', 'horizontalDomain', 'westernExtent'], ['request', 'horizontalDomain', 'easternExtent']]</td></tr></table>
81</body></html>
Note: See TracBrowser for help on using the repository browser.