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

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx/doc/optionHandler_module.txt@793
Revision 793, 3.8 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 optionHandler:
2
3NAME
4    optionHandler
5
6FILE
7    /usr/local/dx-0.1.1/optionHandler.py
8
9DESCRIPTION
10    optionHandler.py
11    ================
12   
13    Holds the OptionHandler class that is used to generate available
14    option lists to send to the user via whichever presentation layer
15    is being used.
16
17CLASSES
18    datasetdb.Datasetdb
19        OptionHandler
20   
21    class OptionHandler(datasetdb.Datasetdb)
22     |  I think this should be a sub-class of Datasetdb so that you
23     |  wrap the functionality already in place but send it the allowed_groups
24     |  so that it can send back a list of everything available. Thereby taking
25     |  the logic out of the CGIInterface class.
26     |  All lists are sorted alphanumerically here before being exported to
27     |  other parts of the dx package.
28     | 
29     |  Methods defined here:
30     | 
31     |  __init__(self, allowedGroups)
32     |      Method to initialise class. Calls __init__ method for parent class
33     |      and sets allowedGroups instance variable.
34     | 
35     |  getDatasetGroupList(self)
36     |      Method returning a sorted list of all the dataset groups available
37     |      to the particular user.
38     | 
39     |  getDatasetList(self, datasetGroup)
40     |      Method to return the available datasets within a given dataset group as
41     |      a sorted list.
42     | 
43     |  getVariableList(self, datasetGroup=None, dataset=None, datasetURI=None)
44     |      Method to return list of available variables for the given datasetGroup
45     |      and dataset/datasetURI.
46     | 
47     |  ----------------------------------------------------------------------
48     |  Methods inherited from datasetdb.Datasetdb:
49     | 
50     |  getCFGlobalAttributes(self, datafile)
51     |      getCFGlobalAttributes method - gets any CF metadta global attributes that are available
52     |      from the source dataset/file.
53     | 
54     |  getDatasetGroupFromURI(self, datasetURI)
55     |      getDatasetGroupFromURI method - gets the id of the dataset group from a
56     |      datasetURI (if it is known to the dx).
57     | 
58     |  getDatasetGroups(self)
59     |      getDatasetGroups method - returns the dataset groups that the dx knows about.
60     | 
61     |  getDatasetURIList(self)
62     |      getDatasetURILList method - gets a list of all the datasetURIs visible
63     |      to this version of dx (in the config.py file).
64     | 
65     |  getDatasets(self, datasetGroup)
66     |      getDatasets method - returns the datasets associated with the dataset group
67     |      argument.
68     | 
69     |  getDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
70     |      getDomain method - returns the combined horizontal, vertical and temporal domains.
71     | 
72     |  getHorizontalSpatialDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
73     | 
74     |  getProtectID(datasetGroup=None, datasetURI=None)
75     |      getProtectID method - returns the security group for a given dataset group or
76     |      datasetURI (if known to the dx).
77     | 
78     |  getTemporalDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
79     |      getTemporalDomain method - returns the temporal domain as a tuple of (start time, end time,
80     |      (interval value, interval units)).
81     | 
82     |  getVariables(self, datasetGroup=None, dataset=None, datasetURI=None)
83     |      getVariables method - returns a list of variables ior the given dataset
84     |      group/dataset combination or datasetURI. The variable name used is selected
85     |      hierarchically depending on the available attributes.
86     | 
87     |  getVerticalSpatialDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
88     |      getVerticalSpatialDomain method - returns the vertical domain as a tuple containing
89     |      a list of levels (or "Single level" string) and the units.
90
Note: See TracBrowser for help on using the repository browser.