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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*------------------------------------------------------------------------------
* Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team
*
* Distributable under the terms of either the Apache License (Version 2.0) or
* the GNU Lesser General Public License, as specified in the COPYING file.
------------------------------------------------------------------------------*/
#ifndef _lucene_queryParser_QueryParserBase_
#define _lucene_queryParser_QueryParserBase_
#if defined(_LUCENE_PRAGMA_ONCE)
# pragma once
#endif
#include "CLucene/util/VoidList.h"
#include "CLucene/search/BooleanClause.h"
#include "CLucene/analysis/Analyzers.h"
#include "QueryToken.h"
CL_NS_DEF(queryParser)
/**
* Contains default implementations used by QueryParser.
* You can override any of these to provide a customised QueryParser.
*/
class QueryParserBase:LUCENE_BASE
{
protected:
/* The actual operator the parser uses to combine query terms */
int defaultOperator;
int32_t phraseSlop;
bool lowercaseExpandedTerms;
LUCENE_STATIC_CONSTANT(int, CONJ_NONE=0);
LUCENE_STATIC_CONSTANT(int, CONJ_AND=1);
LUCENE_STATIC_CONSTANT(int, CONJ_OR=2);
LUCENE_STATIC_CONSTANT(int, MOD_NONE=0);
LUCENE_STATIC_CONSTANT(int, MOD_NOT=10);
LUCENE_STATIC_CONSTANT(int, MOD_REQ=11);
CL_NS(analysis)::Analyzer* analyzer;
public:
QueryParserBase(CL_NS(analysis)::Analyzer* analyzer);
~QueryParserBase();
/**
* Whether terms of wildcard, prefix, fuzzy and range queries are to be automatically
* lower-cased or not. Default is <code>true</code>.
*/
void setLowercaseExpandedTerms(bool lowercaseExpandedTerms);
/**
* @see #setLowercaseExpandedTerms(boolean)
*/
bool getLowercaseExpandedTerms() const;
//values used for setOperator
LUCENE_STATIC_CONSTANT(int, OR_OPERATOR=0);
LUCENE_STATIC_CONSTANT(int, AND_OPERATOR=1);
/**
* Sets the boolean operator of the QueryParser.
* In default mode (<code>OR_OPERATOR</code>) terms without any modifiers
* are considered optional: for example <code>capital of Hungary</code> is equal to
* <code>capital OR of OR Hungary</code>.<br/>
* In <code>AND_OPERATOR</code> mode terms are considered to be in conjuction: the
* above mentioned query is parsed as <code>capital AND of AND Hungary</code>
*/
void setDefaultOperator(int oper);
/**
* Gets implicit operator setting, which will be either AND_OPERATOR
* or OR_OPERATOR.
*/
int getDefaultOperator() const;
//public so that the lexer can call this
virtual void throwParserException(const TCHAR* message, TCHAR ch, int32_t col, int32_t line );
/**
* Sets the default slop for phrases. If zero, then exact phrase matches
* are required. Default value is zero.
*/
void setPhraseSlop(int phraseSlop) { this->phraseSlop = phraseSlop; }
/**
* Gets the default slop for phrases.
*/
int getPhraseSlop() { return phraseSlop; }
protected:
/**
* Removes the escaped characters
*/
void discardEscapeChar(TCHAR* token) const;
//Analyzes the expanded term termStr with the StandardFilter and the LowerCaseFilter.
TCHAR* AnalyzeExpandedTerm(const TCHAR* field, TCHAR* termStr);
// Adds the next parsed clause.
virtual void AddClause(std::vector<CL_NS(search)::BooleanClause*>& clauses, int32_t conj, int32_t mods, CL_NS(search)::Query* q);
/**
* Returns a termquery, phrasequery for the specified field.
* Note: this is only a partial implementation, since MultiPhraseQuery is not implemented yet
* return NULL to disallow
*/
virtual CL_NS(search)::Query* GetFieldQuery(const TCHAR* field, TCHAR* queryText);
/**
* Delegates to GetFieldQuery(string, string), and adds slop onto phrasequery.
* Can be used to remove slop functionality
*/
virtual CL_NS(search)::Query* GetFieldQuery(const TCHAR* field, TCHAR* queryText, int32_t slop);
/**
* Factory method for generating a query (similar to
* {@link #GetWildcardQuery}). Called when parser parses an input term
* token that uses prefix notation; that is, contains a single '*' wildcard
* character as its last character. Since this is a special case
* of generic wildcard term, and such a query can be optimized easily,
* this usually results in a different query object.
*<p>
* Depending on settings, a prefix term may be lower-cased
* automatically. It will not go through the default Analyzer,
* however, since normal Analyzers are unlikely to work properly
* with wildcard templates.
*<p>
* Can be overridden by extending classes, to provide custom handling for
* wild card queries, which may be necessary due to missing analyzer calls.
*
* @param field Name of the field query will use.
* @param termStr Term token to use for building term for the query
* (<b>without</b> trailing '*' character!)
*
* @return Resulting {@link Query} built for the term
* return NULL to disallow
*/
virtual CL_NS(search)::Query* GetPrefixQuery(const TCHAR* field, TCHAR* termStr);
/**
* Factory method for generating a query. Called when parser
* parses an input term token that contains one or more wildcard
* characters (? and *), but is not a prefix term token (one
* that has just a single * character at the end)
*<p>
* Depending on settings, prefix term may be lower-cased
* automatically. It will not go through the default Analyzer,
* however, since normal Analyzers are unlikely to work properly
* with wildcard templates.
*<p>
* Can be overridden by extending classes, to provide custom handling for
* wildcard queries, which may be necessary due to missing analyzer calls.
*
* @param field Name of the field query will use.
* @param termStr Term token that contains one or more wild card
* characters (? or *), but is not simple prefix term
*
* @return Resulting {@link Query} built for the term
* return NULL to disallow
*/
virtual CL_NS(search)::Query* GetWildcardQuery(const TCHAR* field, TCHAR* termStr);
/**
* Factory method for generating a query (similar to
* {@link #GetWildcardQuery}). Called when parser parses
* an input term token that has the fuzzy suffix (~) appended.
*
* @param field Name of the field query will use.
* @param termStr Term token to use for building term for the query
*
* @return Resulting {@link Query} built for the term
* return NULL to disallow
*/
virtual CL_NS(search)::Query* GetFuzzyQuery(const TCHAR* field, TCHAR* termStr);
/**
* Factory method for generating query, given a set of clauses.
* By default creates a boolean query composed of clauses passed in.
*
* Can be overridden by extending classes, to modify query being
* returned.
*
* @param clauses Vector that contains {@link BooleanClause} instances
* to join.
*
* @return Resulting {@link Query} object.
* return NULL to disallow
*
* Memory: clauses must all be cleaned up by this function.
*/
virtual CL_NS(search)::Query* GetBooleanQuery(std::vector<CL_NS(search)::BooleanClause*>& clauses);
/**
* return NULL to disallow
*/
virtual CL_NS(search)::Query* GetRangeQuery(const TCHAR* field, TCHAR* part1, TCHAR* part2, bool inclusive);
virtual CL_NS(search)::Query* ParseRangeQuery(const TCHAR* field, TCHAR* str, bool inclusive);
};
CL_NS_END
#endif
|
