source: mauRepo/CedaManager/trunk/ceda_markup/opensearch/osquery.py @ 8369

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

CedaManager? contains python class definition for many markup languages used in ceda projects

  • 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 4 May 2012
30
31@author: Maurizio Nagni
32'''
33from abc import abstractmethod
34
35URL_REL_RESULTS = 'results'
36URL_REL_SUGGESTIONS = 'suggestions'
37URL_REL_SELF = 'self'
38URL_REL_COLLECTIONS = 'collection'
39URL_REL = [URL_REL_RESULTS, URL_REL_SUGGESTIONS, URL_REL_SELF, URL_REL_COLLECTIONS]
40
41URL_REL_DEFAULT = URL_REL_RESULTS
42URL_INDEX_OFFSET_DEFAULT = 1
43URL_PAGE_OFFSET_DEFAULT = 1
44
45class OSQuery(object):   
46    '''
47    classdocs
48    '''
49    def __init__(self, params_model, rel = URL_REL_DEFAULT, indexOffset = URL_INDEX_OFFSET_DEFAULT, pageOffset = URL_PAGE_OFFSET_DEFAULT):
50        """
51            @param params_model: URL's params as OSParam instances array       
52            @param rel: URL's 'rel' attribute
53            @param indexOffset: URL's 'indexOffset' attribute
54            @param pageOffset: URL's 'pageOffset' attribute           
55        """
56        self.params_model = params_model
57       
58        if rel and rel in URL_REL:
59            self.rel = rel
60        else:
61            self.rel = URL_REL_DEFAULT
62       
63        if indexOffset and isinstance(indexOffset, (int, long)) and indexOffset > 0:
64            self.indexOffset = indexOffset
65        else:
66            self.indexOffset = URL_INDEX_OFFSET_DEFAULT   
67       
68        if pageOffset and isinstance(pageOffset, (int, long)) and pageOffset > 0:           
69            self.pageOffset = pageOffset
70        else:
71            self.pageOffset = URL_PAGE_OFFSET_DEFAULT
72           
73    @abstractmethod
74    def doSearch(self, **kwargs):
75        pass
76       
77   
Note: See TracBrowser for help on using the repository browser.