source: mauRepo/CedaMarkup/trunk/ceda_markup/opensearch/os_engine.py @ 8418

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/mauRepo/CedaMarkup/trunk/ceda_markup/opensearch/os_engine.py@8418
Revision 8418, 3.4 KB checked in by mnagni, 7 years ago (diff)

Incomplete - # 22513: missing ValidTime? in the GML tag library
 http://team.ceda.ac.uk/trac/ceda/ticket/22513

Even if this release adds the required tag, the most important difference with the version 0.0.2 is the library itself which has been deeply changed to add more flexibility for future development.
The main difference is that now the class is not composed by classes per markup type but from createXXX function per markup type which directly return an Element instance.

Another major add is a rich collection of unittests

  • Property svn:mime-type set to text/plain
Line 
1'''
2BSD Licence
3Copyright (c) 2012, Science & Technology Facilities Council (STFC)
4All rights reserved.
5
6Redistribution and use in source and binary forms, with or without modification,
7are permitted provided that the following conditions are met:
8
9    * Redistributions of source code must retain the above copyright notice,
10        this list of conditions and the following disclaimer.
11    * Redistributions in binary form must reproduce the above copyright notice,
12        this list of conditions and the following disclaimer in the documentation
13        and/or other materials provided with the distribution.
14    * Neither the name of the Science & Technology Facilities Council (STFC)
15        nor the names of its contributors may be used to endorse or promote
16        products derived from this software without specific prior written permission.
17
18THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
22BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
23OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29Created on 24 May 2012
30
31@author: Maurizio Nagni
32'''
33
34import mimetypes
35from query import QueryTag
36from os_engine_helper import OSEngineHelper
37
38if not mimetypes.inited:
39    mimetypes.init()
40    if not mimetypes.types_map.has_key('.atom'):
41        mimetypes.add_type('application/atom+xml', '.atom')
42    if not mimetypes.types_map.has_key('.opensearchdescription'):       
43        mimetypes.add_type('application/opensearchdescription+xml', '.opensearchdescription')
44
45def get_mimetype(extension):
46    return mimetypes.types_map[('.%s') % (extension)] 
47
48class OSEngine(object):
49    '''
50    classdocs
51    '''
52
53    def __init__(self, osRequest, osEngineHelper = OSEngineHelper()):
54        '''
55        Constructor
56            @param osRequest: an OSREquest instance
57            @param ospath: the URL where the OpenSearch service is hosted
58            @param osEngineHelper:
59        '''
60        self.osRequest = osRequest
61        self.osEngineHelper = osEngineHelper
62        self.osHostURL = 'http://localhost'             
63       
64    def doSearch(self, hostURL, mimetype, params_values, **kwargs):
65        self.osHostURL = hostURL
66        response = None
67        for item in self.osRequest.responses:
68            if item.extension == mimetype:
69                response = item
70        if response:
71            kwargs['params_values'] = params_values
72            queries = QueryTag.queryWithRoleRequest(mimetype, self.osRequest.query.params_model, params_values)
73            results = self.osRequest.query.doSearch(**kwargs)
74            return response.generateResponse(results, [queries], self.osHostURL, **kwargs)
75        return None               
76   
77    def getDescription(self, ospath):
78        reqDoc = self.osRequest.getDescription(ospath)
79        self.osEngineHelper.additionalDescription(reqDoc)
80        return reqDoc
Note: See TracBrowser for help on using the repository browser.