source: TI07-MOLES/trunk/PythonCode/wsgi/DIF.py @ 2366

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI07-MOLES/trunk/PythonCode/wsgi/DIF.py@2366
Revision 2366, 8.5 KB checked in by lawrence, 13 years ago (diff)

Improvements on DIF rendering, Source and Sensor display.

Line 
1# python class to support methods on a DIF ... to conform with
2# renderEntity etc ...
3#
4from Utilities import *
5from geoUtilities import *
6from People import *
7from AccessControl import AccessControl
8from ETxmlView import loadET, nsdumb
9from renderEntity import renderEntity
10from ServiceBinding import DIFService
11try: #python 2.5
12    from xml.etree import ElementTree as ET
13except ImportError:
14    try:
15        # if you've installed it yourself it comes this way
16        import ElementTree as ET
17    except ImportError:
18        # if you've egged it this is the way it comes
19        from elementtree import ElementTree as ET
20debug=1
21   
22def shortLong(targetList,s,l):
23    ''' Format a short-long name combination as a string, and add to a list if non-empty,
24    and a non-duplicate'''
25    if l<>'':
26        if s<>'': 
27            r='%s (%s)'%(l,s)
28        else:
29            r=l
30    elif s<>'': r=s
31    if r not in targetList: targetList.append(r)
32    return targetList
33
34class DIF:
35    ''' Supports the NASA GCMD DIF format for python operations,
36    note ... not a complete implementation, currently minimum to
37    show a reasonable piece of content '''
38    def __init__(self,xml,et=0,debug=0,ndgObject=None):
39       
40        '''Initialise a python dif instance based on an xml document (expected
41        to be an input string if et=0, otherwise an ElementTree instance) '''
42        if et:
43            try:
44                self.tree=xml
45                self.xml=ET.tostring(xml)
46            except:
47                raise TypeError,'DIF input is not a valid ElementTree instance'
48        else:
49            try:
50                self.tree=loadET(xml)
51                self.xml=xml
52            except: # for some reason we can't parse the document, and it's worth knowing why
53                if isinstance(xml,str):
54                    l=min(len(xml),300)-1
55                    if l!=len(xml):xml=xml[0:l]+'\n...'
56                    raise ValueError,'DIF input cannot be parsed into an ElementTree instance:\n%s'%xml
57                else:
58                    raise TypeError,'DIF input of type [%s] needs to be a string!'%type(xml)
59       
60        self.debug=debug
61       
62        # if this is an ndgObject that'll have been sorted externally ...
63        self.ndgObject=ndgObject
64       
65        # now try and interpret it
66       
67        helper=nsdumb(self.tree)
68        self.metadataType='DIF'
69        if helper.strip(self.tree.tag)!=self.metadataType: 
70            self.tree=helper.find(self.tree,self.metadataType)
71            if self.tree is None: 
72                raise ValueError, 'DIF input does not include a DIF element:\n%s'%self.xml
73       
74        self.entryID=helper.getText(self.tree,'Entry_ID')
75        self.abstract=helper.getText(self.tree,'Summary')
76        self.name=helper.getText(self.tree,'Entry_Title')
77        self.abbreviation=self.name[0:min(5,len(self.name))]
78       
79        #Note that entity.constraints.html is about access control on the metadata,
80        #and so we don't populate this here ...
81        self.constraints=AccessControl(None)
82       
83        #need entity.parameters, entity.bbox, entity.timeCoverage, entity.curator, entity.creators
84        # nb, two ways of parameters being stored
85        self.parameters=[]
86        for parameter in helper.findall(self.tree,'Parameters'):
87            name=''
88            for level in ['Category','Topic','Term','Variable','Detailed_Variable']:
89                    name+=helper.getText(parameter,level)+'>'
90            name=name.rstrip('>')
91            #print '[%s]\n%s'%(name,ET.tostring(parameter))
92            if name=='':
93                name=helper.getText(parameter,'.')#.text
94                if name is not None: 
95                    #self.parameters.append(name.replace('>','/'))
96                    while len(name.split('>'))<5:name+='>'
97            self.parameters.append(name)
98       
99        #sensors are pretty important too
100        self.sensors=[]
101        for sensor in helper.findall(self.tree,'Sensor_Name'):
102            s,l=helper.getText(sensor,'Short_Name'),helper.getText(sensor,'Long_Name')
103            self.sensors=shortLong(self.sensors,s,l)
104               
105        #and sources
106        self.sources=[]
107        for source in helper.findall(self.tree,'Source_Name'):
108            s,l=helper.getText(source,'Short_Name'),helper.getText(source,'Long_Name')
109            self.sources=shortLong(self.sources,s,l)
110
111        #load up information about spatial bounding box
112        self.bbox=Bounding(self.tree,entity='DIF',getter=helper.getText)
113       
114        #load up information about temporal extent
115        tc=(
116            helper.getText(self.tree,'Temporal_Coverage/Start_Date'),
117            helper.getText(self.tree,'Temporal_Coverage/Stop_Date'),
118            helper.getText(self.tree,'Data_Set_Progress') )
119        self.timeCoverage=TimeCoverage(tc)
120       
121        #load up those silly paleo keywords
122        self.paleoKeywords=[]
123        paleoElements=helper.findall(self.tree,'Paleo_Temporal_Coverage')
124        for e in paleoElements:
125            self.paleoKeywords.append(helper.getText(e,'Chronostratigraphic_Unit'))
126           
127        #Data curator information
128        self.centre=DIFcontact(helper.find(self.tree,'Data_Center'),ctype='centre',helper=helper)
129        self.curator=DIFcontact(helper.find(self.tree,'Data_Curator'),ctype='centre',helper=helper)
130        if self.curator is None:self.curator=self.centre
131       
132        #Data Creators
133        self.creators=[]
134        # use author here because a full dif entry for creator wont necessarily exist in citation ...
135        self.authors=DIFAuthors(self.tree,helper)
136        self.date=dateParse(helper.getText(self.tree,'Data_Set_Citation/Dataset_Release_Date'),'YYYY')
137        if self.date=='': self.date='XXXX'
138        self.title=helper.getText(self.tree,'Data_Set_Citation/Dataset_Title')
139        self.briefCitation=None
140        if (self.authors!='' and self.date!='' and self.title!=''):
141            self.briefCitation='%s (%s): %s'%(self.authors,self.date,self.title)
142        #services
143        self.services=[]
144
145        for item in helper.findall(self.tree,'Related_URL'):
146            self.services.append(
147                DIFService(
148                 helper.getText(item,'URL_Content_Type'),
149                 helper.getText(item,'URL'),
150                 helper.getText(item,'Description') ))
151       
152        if self.ndgObject is None:
153            self.binding=None
154        else:
155            if self.ndgObject.discoveryURL is not None:
156                self.binding=DIFService('DISCOVERY',self.ndgObject.discoveryURL,'Discovery record')
157            else: self.binding=None
158
159        if self.debug:
160           f=open('difs.log','a')
161           f.write('%s##\n%s\n##################################\n'%(self.entryID,self.xml))
162           f.close()
163           
164    def toHTML(self,config):
165
166        if self.tree is not None:
167            renderer=renderEntity(config)
168            return renderer.render(self)
169        else:
170            return '<p>No Valid DIF</p>'
171
172
173import unittest
174
175class TestCase(unittest.TestCase):
176    """
177    """
178
179    inputFile = 'examples/neodc.eg1.dif'
180    inputFile2= 'examples/bodc.eg2.edmed.dif'
181    inputFile2= 'examples/bodc.eg3.difChange.dif'
182    configFile='examples/example.config'
183   
184    def setUp(self):
185        ''' Load example config and DIF files for testing '''
186        f=file(self.inputFile2,'r')
187        xml=f.read()
188        self.dif=DIF(xml)
189        self.config=myConfig(self.configFile)
190
191    def testEntries(self):
192        ''' Testing the DIF object can be loaded and some key entries extracted '''
193        print 'Entry ID [%s]'%self.dif.entryID
194        print 'Author [%s]'%self.dif.authors
195       
196    def testrenderDIF(self):
197        ''' Testing the conversion to html '''
198        print self.dif.timeCoverage
199        html=self.dif.toHTML(self.config)
200        g=file('difOutput.html','w')
201        g.write(html)
202   
203    def testParameters(self):
204        ''' Testing obtaining parameters from an edmed dif in original format '''
205        print 'Parameters %s'%self.dif.parameters
206       
207    def testDifficult(self):
208        ''' Grab a test example from the internet and load it '''
209        from ndgRetrieve import ndgRetrieve
210        retriever=ndgRetrieve('./')
211        #testURI='grid.bodc.nerc.ac.uk__DIF__EDMED1048008'
212        testURI='neodc.nerc.ac.uk__DIF__NEODC_NEXTMAP'
213        inputs={'repository':'glue.badc.rl.ac.uk','uri':testURI,'format':'original','type':'xml','original':'1'}
214        ctype,r=retriever._present(inputs,'text/html')
215        d=DIF(r)
216        print d.entryID,[str(i) for i in d.services]
217
218
219if __name__=="__main__":
220    unittest.main()
221
222       
223       
Note: See TracBrowser for help on using the repository browser.