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

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

Put all the old code in the old_stuff branch.

Line 
1Help on module validate:
2
3NAME
4    validate
5
6FILE
7    /usr/local/dx-0.1.1/validate.py
8
9DESCRIPTION
10    validate.py
11    ===========
12   
13    Contains the class Validate used to validate the contents of a request
14    against the availability within a dataset.
15   
16    Most of this functionality should now be done in the javascript for
17    the CGI-based Data Extractor.
18
19CLASSES
20    extractMetadata.MetadataExtractor
21        Validater
22   
23    class Validater(extractMetadata.MetadataExtractor)
24     |  Class to validate the contents of a user request against the
25     |  available datasets.
26     | 
27     |  Methods defined here:
28     | 
29     |  __init__(self)
30     | 
31     |  ----------------------------------------------------------------------
32     |  Methods inherited from extractMetadata.MetadataExtractor:
33     | 
34     |  getFileList(self)
35     |      Method that returns the list of files associated with a particular
36     |      request. If more than one variable has been selected then the list
37     |      contains a concatenation of allVar1Files+allVar2Files.....+allVarNFiles.
38     | 
39     |  getRequestSizeInBytes(self)
40     |      Method to get the size of the request in bytes.
41     | 
42     |  getTimeStepCount(self)
43     |      Method to return the number of time steps requested.
44     | 
45     |  getTimeSteps(self, dset_num=1)
46     |      Method to return a list of tuples for all timesteps requested.
47
Note: See TracBrowser for help on using the repository browser.