source: TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/datasetdb_module.txt @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx_source/for_usr_local/dx/doc/datasetdb_module.txt@793
Revision 793, 3.9 KB checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

Line 
1Help on module datasetdb:
2
3NAME
4    datasetdb
5
6FILE
7    /usr/local/dx-0.1.1/datasetdb.py
8
9DESCRIPTION
10    datasets.py
11    ===========
12   
13    Datasets module for the dx package.
14   
15    This module holds the Datasetdb class that is used
16    to hold and access information about datasets visible
17    to the dx package.
18
19CLASSES
20    dxdmlHandler.DXDMLHandler
21        Datasetdb
22   
23    class Datasetdb(dxdmlHandler.DXDMLHandler)
24     |  Datasetdb class - a group of methods to connect to a dataset group or
25     |  dataset to extract information about the contents.
26     | 
27     |  Methods defined here:
28     | 
29     |  __init__(self)
30     |      __init__ method - set up instance variables.
31     | 
32     |  getCFGlobalAttributes(self, datafile)
33     |      getCFGlobalAttributes method - gets any CF metadta global attributes that are available
34     |      from the source dataset/file.
35     | 
36     |  getDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
37     |      getDomain method - returns the combined horizontal, vertical and temporal domains.
38     | 
39     |  getHorizontalDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
40     | 
41     |  getTemporalDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
42     |      getTemporalDomain method - returns the temporal domain as a tuple of (start time, end time,
43     |      (interval value, interval units)).
44     | 
45     |  getVariables(self, datasetGroup=None, dataset=None, datasetURI=None)
46     |      getVariables method - returns a list of variables ior the given dataset
47     |      group/dataset combination or datasetURI. The variable name used is selected
48     |      hierarchically depending on the available attributes.
49     | 
50     |  getVerticalSpatialDomain(self, datasetGroup=None, dataset=None, variable=None, datasetURI=None)
51     |      getVerticalSpatialDomain method - returns the vertical domain as a tuple containing
52     |      a list of levels (or "Single level" string) and the units.
53     | 
54     |  ----------------------------------------------------------------------
55     |  Methods inherited from dxdmlHandler.DXDMLHandler:
56     | 
57     |  getDatasetGroupFromURI(self, datasetURI)
58     |      getDatasetGroupFromURI method - gets the id of the dataset group from a
59     |      datasetURI (if it is known to the dx).
60     | 
61     |  getDatasetGroups(self)
62     |      Returns a list of the Dataset Groups that the dx knows about.
63     | 
64     |  getDatasetURI(self, datasetGroup, dataset)
65     |      Returns a datasetURI from a known dataset group and dataset.
66     | 
67     |  getDatasetURIList(self)
68     |      Returns a list of all the datasetURIs visible to this version of dx.
69     |      NOTE: datasetURI maps to usageMetadataLink in the XML.
70     | 
71     |  getDatasets(self, datasetGroup)
72     |      Returns a list of the Datasets available for the given Dataset Group.
73     | 
74     |  getDatasetsAndDatasetURIs(self, datasetGroup)
75     |      Returns a list of (dataset, datasetURI) tuples for each dataset availabe in the
76     |      fiven datasetGroup.
77     | 
78     |  getFileNamePrefix(self, datasetGroup)
79     |      Returns the filename prefix for the given Dataset Group.
80     | 
81     |  getFileNameSection(self, datasetGroup, dataset)
82     |      Return the filename section for the Dataset given (within the Dataset Group given).
83     | 
84     |  getProtectID(self, datasetGroup=None, dataset=None, datasetURI=None)
85     |      getProtectID method - returns the (permittedRoles, permittedUsers) tuple for a given
86     |      dataset group, dataset or datasetURI (if known to the dx). This goes down to the level
87     |      provided by the caller. If just the dataset group is given then only the permissions
88     |      for that are returned. But if the dataset or datasetURI is given then the permissions
89     |      on that are returned. These should always be the same, but one day might not be.
90
Note: See TracBrowser for help on using the repository browser.