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

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/dxdmlHandler.html@793
Revision 793, 6.5 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 dxdmlHandler</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>dxdmlHandler</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/dxdmlHandler.py">/usr/local/dx-0.1.1/dxdmlHandler.py</a></font></td></tr></table>
12    <p><tt>dxdmlHandler.py<br>
13===============<br>
14&nbsp;<br>
15Holds&nbsp;the&nbsp;<a href="#DXDMLHandler">DXDMLHandler</a>&nbsp;class&nbsp;for&nbsp;parsing&nbsp;and&nbsp;writing&nbsp;the<br>
16Data&nbsp;Extractor's&nbsp;Dataset&nbsp;Markup&nbsp;Language&nbsp;(DXDML).</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></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
27<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
28<tr bgcolor="#ee77aa">
29<td colspan=3 valign=bottom>&nbsp;<br>
30<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
31   
32<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
33<td width="100%"><dl>
34<dt><font face="helvetica, arial"><a href="dxdmlHandler.html#DXDMLHandler">DXDMLHandler</a>
35</font></dt></dl>
36 <p>
37<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
38<tr bgcolor="#ffc8d8">
39<td colspan=3 valign=bottom>&nbsp;<br>
40<font color="#000000" face="helvetica, arial"><a name="DXDMLHandler">class <strong>DXDMLHandler</strong></a></font></td></tr>
41   
42<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
43<td colspan=2><tt>Handler&nbsp;class&nbsp;for&nbsp;DX&nbsp;Dataset&nbsp;objects&nbsp;-&nbsp;used&nbsp;as&nbsp;input&nbsp;data&nbsp;to&nbsp;the&nbsp;DX.<br>&nbsp;</tt></td></tr>
44<tr><td>&nbsp;</td>
45<td width="100%">Methods defined here:<br>
46<dl><dt><a name="DXDMLHandler-__init__"><strong>__init__</strong></a>(self, xmlfile<font color="#909090">='/usr/local/dx/datasets/inputDatasets.xml'</font>)</dt><dd><tt>Initialises&nbsp;the&nbsp;instance&nbsp;by&nbsp;parsing&nbsp;an&nbsp;xmlfile.</tt></dd></dl>
47
48<dl><dt><a name="DXDMLHandler-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>
49datasetURI&nbsp;(if&nbsp;it&nbsp;is&nbsp;known&nbsp;to&nbsp;the&nbsp;dx).</tt></dd></dl>
50
51<dl><dt><a name="DXDMLHandler-getDatasetGroups"><strong>getDatasetGroups</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;the&nbsp;Dataset&nbsp;Groups&nbsp;that&nbsp;the&nbsp;dx&nbsp;knows&nbsp;about.</tt></dd></dl>
52
53<dl><dt><a name="DXDMLHandler-getDatasetURI"><strong>getDatasetURI</strong></a>(self, datasetGroup, dataset)</dt><dd><tt>Returns&nbsp;a&nbsp;datasetURI&nbsp;from&nbsp;a&nbsp;known&nbsp;dataset&nbsp;group&nbsp;and&nbsp;dataset.</tt></dd></dl>
54
55<dl><dt><a name="DXDMLHandler-getDatasetURIList"><strong>getDatasetURIList</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;all&nbsp;the&nbsp;datasetURIs&nbsp;visible&nbsp;to&nbsp;this&nbsp;version&nbsp;of&nbsp;dx.<br>
56NOTE:&nbsp;datasetURI&nbsp;maps&nbsp;to&nbsp;usageMetadataLink&nbsp;in&nbsp;the&nbsp;XML.</tt></dd></dl>
57
58<dl><dt><a name="DXDMLHandler-getDatasets"><strong>getDatasets</strong></a>(self, datasetGroup)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;the&nbsp;Datasets&nbsp;available&nbsp;for&nbsp;the&nbsp;given&nbsp;Dataset&nbsp;Group.</tt></dd></dl>
59
60<dl><dt><a name="DXDMLHandler-getDatasetsAndDatasetURIs"><strong>getDatasetsAndDatasetURIs</strong></a>(self, datasetGroup)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;(dataset,&nbsp;datasetURI)&nbsp;tuples&nbsp;for&nbsp;each&nbsp;dataset&nbsp;availabe&nbsp;in&nbsp;the<br>
61fiven&nbsp;datasetGroup.</tt></dd></dl>
62
63<dl><dt><a name="DXDMLHandler-getFileNamePrefix"><strong>getFileNamePrefix</strong></a>(self, datasetGroup)</dt><dd><tt>Returns&nbsp;the&nbsp;filename&nbsp;prefix&nbsp;for&nbsp;the&nbsp;given&nbsp;Dataset&nbsp;Group.</tt></dd></dl>
64
65<dl><dt><a name="DXDMLHandler-getFileNameSection"><strong>getFileNameSection</strong></a>(self, datasetGroup, dataset)</dt><dd><tt>Return&nbsp;the&nbsp;filename&nbsp;section&nbsp;for&nbsp;the&nbsp;Dataset&nbsp;given&nbsp;(within&nbsp;the&nbsp;Dataset&nbsp;Group&nbsp;given).</tt></dd></dl>
66
67<dl><dt><a name="DXDMLHandler-getProtectID"><strong>getProtectID</strong></a>(self, datasetGroup<font color="#909090">=None</font>, dataset<font color="#909090">=None</font>, datasetURI<font color="#909090">=None</font>)</dt><dd><tt>getProtectID&nbsp;method&nbsp;-&nbsp;returns&nbsp;the&nbsp;(permittedRoles,&nbsp;permittedUsers)&nbsp;tuple&nbsp;for&nbsp;a&nbsp;given&nbsp;<br>
68dataset&nbsp;group,&nbsp;dataset&nbsp;or&nbsp;datasetURI&nbsp;(if&nbsp;known&nbsp;to&nbsp;the&nbsp;dx).&nbsp;This&nbsp;goes&nbsp;down&nbsp;to&nbsp;the&nbsp;level<br>
69provided&nbsp;by&nbsp;the&nbsp;caller.&nbsp;If&nbsp;just&nbsp;the&nbsp;dataset&nbsp;group&nbsp;is&nbsp;given&nbsp;then&nbsp;only&nbsp;the&nbsp;permissions<br>
70for&nbsp;that&nbsp;are&nbsp;returned.&nbsp;But&nbsp;if&nbsp;the&nbsp;dataset&nbsp;or&nbsp;datasetURI&nbsp;is&nbsp;given&nbsp;then&nbsp;the&nbsp;permissions<br>
71on&nbsp;that&nbsp;are&nbsp;returned.&nbsp;These&nbsp;should&nbsp;always&nbsp;be&nbsp;the&nbsp;same,&nbsp;but&nbsp;one&nbsp;day&nbsp;might&nbsp;not&nbsp;be.</tt></dd></dl>
72
73</td></tr></table></td></tr></table><p>
74<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
75<tr bgcolor="#55aa55">
76<td colspan=3 valign=bottom>&nbsp;<br>
77<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
78   
79<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
80<td width="100%"><strong>INPUT_DATASETS_FILE</strong> = '/usr/local/dx/datasets/inputDatasets.xml'</td></tr></table>
81</body></html>
Note: See TracBrowser for help on using the repository browser.