1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/*
* Copyright 2005-2008 Fabrice Colin
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef _SEARCH_ENGINE_INTERFACE_H
#define _SEARCH_ENGINE_INTERFACE_H
#include <time.h>
#include <string>
#include <set>
#include <vector>
#include "DocumentInfo.h"
#include "Visibility.h"
#include "QueryProperties.h"
using namespace std;
/// Interface implemented by search engines.
class PINOT_EXPORT SearchEngineInterface
{
public:
typedef enum { DEFAULT_OP_AND = 0, DEFAULT_OP_OR } DefaultOperator;
virtual ~SearchEngineInterface();
/// Sets whether AND is the default operator.
virtual void setDefaultOperator(DefaultOperator op);
/// Sets the set of documents to limit to.
virtual bool setLimitSet(const set<string> &docsSet);
/// Sets the set of documents to expand from.
virtual bool setExpandSet(const set<string> &docsSet);
/// Runs a query; true if success.
virtual bool runQuery(QueryProperties& queryProps,
unsigned int startDoc = 0) = 0;
/// Returns the results for the previous query.
virtual const vector<DocumentInfo> &getResults(void) const;
/// Returns an estimate of the total number of results for the previous query.
virtual unsigned int getResultsCountEstimate(void) const;
/// Returns the charset for the previous query's results.
virtual string getResultsCharset(void) const;
/// Suggests a spelling correction.
virtual string getSpellingCorrection(void) const;
/// Returns expand terms from the previous query.
virtual const set<string> &getExpandTerms(void) const;
protected:
DefaultOperator m_defaultOperator;
vector<DocumentInfo> m_resultsList;
unsigned int m_resultsCountEstimate;
string m_charset;
string m_correctedFreeQuery;
set<string> m_expandTerms;
SearchEngineInterface();
private:
SearchEngineInterface(const SearchEngineInterface &other);
SearchEngineInterface &operator=(const SearchEngineInterface &other);
};
#endif // _SEARCH_ENGINE_INTERFACE_H
|
