|
1
|
/**
|
|
2
|
* '$RCSfile$'
|
|
3
|
* Purpose: A Class that represents a structured query, and can be
|
|
4
|
* constructed from an XML serialization conforming to
|
|
5
|
* pathquery.dtd. The printSQL() method can be used to print
|
|
6
|
* a SQL serialization of the query.
|
|
7
|
* Copyright: 2000 Regents of the University of California and the
|
|
8
|
* National Center for Ecological Analysis and Synthesis
|
|
9
|
* Authors: Matt Jones
|
|
10
|
* Release: @release@
|
|
11
|
*
|
|
12
|
* '$Author: sgarg $'
|
|
13
|
* '$Date: 2005-10-26 09:44:56 -0700 (Wed, 26 Oct 2005) $'
|
|
14
|
* '$Revision: 2693 $'
|
|
15
|
*
|
|
16
|
* This program is free software; you can redistribute it and/or modify
|
|
17
|
* it under the terms of the GNU General Public License as published by
|
|
18
|
* the Free Software Foundation; either version 2 of the License, or
|
|
19
|
* (at your option) any later version.
|
|
20
|
*
|
|
21
|
* This program is distributed in the hope that it will be useful,
|
|
22
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
23
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
24
|
* GNU General Public License for more details.
|
|
25
|
*
|
|
26
|
* You should have received a copy of the GNU General Public License
|
|
27
|
* along with this program; if not, write to the Free Software
|
|
28
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
29
|
*/
|
|
30
|
|
|
31
|
package edu.ucsb.nceas.metacat;
|
|
32
|
|
|
33
|
import java.util.Vector;
|
|
34
|
|
|
35
|
/** a utility class that represents a single term in a query */
|
|
36
|
public class QueryTerm
|
|
37
|
{
|
|
38
|
|
|
39
|
private boolean casesensitive = false;
|
|
40
|
|
|
41
|
private String searchmode = null;
|
|
42
|
|
|
43
|
private String value = null;
|
|
44
|
|
|
45
|
private String pathexpr = null;
|
|
46
|
|
|
47
|
private boolean percentageSymbol = false;
|
|
48
|
|
|
49
|
private int countPercentageSearchItem = 0;
|
|
50
|
|
|
51
|
/**
|
|
52
|
* Construct a new instance of a query term for a free text search (using
|
|
53
|
* the value only)
|
|
54
|
*
|
|
55
|
* @param casesensitive
|
|
56
|
* flag indicating whether case is used to match
|
|
57
|
* @param searchmode
|
|
58
|
* determines what kind of substring match is performed (one of
|
|
59
|
* starts-with|ends-with|contains|matches-exactly)
|
|
60
|
* @param value
|
|
61
|
* the text value to match
|
|
62
|
*/
|
|
63
|
public QueryTerm(boolean casesensitive, String searchmode, String value)
|
|
64
|
{
|
|
65
|
this.casesensitive = casesensitive;
|
|
66
|
this.searchmode = searchmode;
|
|
67
|
this.value = value;
|
|
68
|
}
|
|
69
|
|
|
70
|
/**
|
|
71
|
* Construct a new instance of a query term for a structured search
|
|
72
|
* (matching the value only for those nodes in the pathexpr)
|
|
73
|
*
|
|
74
|
* @param casesensitive
|
|
75
|
* flag indicating whether case is used to match
|
|
76
|
* @param searchmode
|
|
77
|
* determines what kind of substring match is performed (one of
|
|
78
|
* starts-with|ends-with|contains|matches-exactly)
|
|
79
|
* @param value
|
|
80
|
* the text value to match
|
|
81
|
* @param pathexpr
|
|
82
|
* the hierarchical path to the nodes to be searched
|
|
83
|
*/
|
|
84
|
public QueryTerm(boolean casesensitive, String searchmode, String value,
|
|
85
|
String pathexpr)
|
|
86
|
{
|
|
87
|
this(casesensitive, searchmode, value);
|
|
88
|
this.pathexpr = pathexpr;
|
|
89
|
}
|
|
90
|
|
|
91
|
/** determine if the QueryTerm is case sensitive */
|
|
92
|
public boolean isCaseSensitive()
|
|
93
|
{
|
|
94
|
return casesensitive;
|
|
95
|
}
|
|
96
|
|
|
97
|
/** get the searchmode parameter */
|
|
98
|
public String getSearchMode()
|
|
99
|
{
|
|
100
|
return searchmode;
|
|
101
|
}
|
|
102
|
|
|
103
|
/** get the Value parameter */
|
|
104
|
public String getValue()
|
|
105
|
{
|
|
106
|
return value;
|
|
107
|
}
|
|
108
|
|
|
109
|
/** get the path expression parameter */
|
|
110
|
public String getPathExpression()
|
|
111
|
{
|
|
112
|
return pathexpr;
|
|
113
|
}
|
|
114
|
|
|
115
|
/** get the percentage count for one query term */
|
|
116
|
public int getPercentageSymbolCount()
|
|
117
|
{
|
|
118
|
return countPercentageSearchItem;
|
|
119
|
}
|
|
120
|
|
|
121
|
/**
|
|
122
|
* create a SQL serialization of the query that this instance represents
|
|
123
|
*/
|
|
124
|
public String printSQL(boolean useXMLIndex)
|
|
125
|
{
|
|
126
|
StringBuffer self = new StringBuffer();
|
|
127
|
|
|
128
|
// Uppercase the search string if case match is not important
|
|
129
|
String casevalue = null;
|
|
130
|
String nodedataterm = null;
|
|
131
|
boolean notEqual = false;
|
|
132
|
if (casesensitive) {
|
|
133
|
nodedataterm = "nodedata";
|
|
134
|
casevalue = value;
|
|
135
|
} else {
|
|
136
|
nodedataterm = "UPPER(nodedata)";
|
|
137
|
casevalue = value.toUpperCase();
|
|
138
|
}
|
|
139
|
|
|
140
|
// Add appropriate wildcards to search string
|
|
141
|
String searchexpr = null;
|
|
142
|
if (searchmode.equals("starts-with")) {
|
|
143
|
searchexpr = nodedataterm + " LIKE '" + casevalue + "%' ";
|
|
144
|
} else if (searchmode.equals("ends-with")) {
|
|
145
|
searchexpr = nodedataterm + " LIKE '%" + casevalue + "' ";
|
|
146
|
} else if (searchmode.equals("contains")) {
|
|
147
|
if (!casevalue.equals("%")) {
|
|
148
|
searchexpr = nodedataterm + " LIKE '%" + casevalue + "%' ";
|
|
149
|
} else {
|
|
150
|
searchexpr = nodedataterm + " LIKE '" + casevalue + "' ";
|
|
151
|
// find percentage symbol
|
|
152
|
percentageSymbol = true;
|
|
153
|
}
|
|
154
|
} else if (searchmode.equals("not-contains")) {
|
|
155
|
notEqual = true;
|
|
156
|
searchexpr = nodedataterm + " LIKE '%" + casevalue + "%' ";
|
|
157
|
} else if (searchmode.equals("equals")) {
|
|
158
|
searchexpr = nodedataterm + " = '" + casevalue + "' ";
|
|
159
|
} else if (searchmode.equals("isnot-equal")) {
|
|
160
|
notEqual = true;
|
|
161
|
searchexpr = nodedataterm + " = '" + casevalue + "' ";
|
|
162
|
} else {
|
|
163
|
String oper = null;
|
|
164
|
if (searchmode.equals("greater-than")) {
|
|
165
|
oper = ">";
|
|
166
|
nodedataterm = "nodedatanumerical";
|
|
167
|
} else if (searchmode.equals("greater-than-equals")) {
|
|
168
|
oper = ">=";
|
|
169
|
nodedataterm = "nodedatanumerical";
|
|
170
|
} else if (searchmode.equals("less-than")) {
|
|
171
|
oper = "<";
|
|
172
|
nodedataterm = "nodedatanumerical";
|
|
173
|
} else if (searchmode.equals("less-than-equals")) {
|
|
174
|
oper = "<=";
|
|
175
|
nodedataterm = "nodedatanumerical";
|
|
176
|
} else {
|
|
177
|
System.out
|
|
178
|
.println("NOT expected case. NOT recognized operator: "
|
|
179
|
+ searchmode);
|
|
180
|
return null;
|
|
181
|
}
|
|
182
|
try {
|
|
183
|
// it is number; numeric comparison
|
|
184
|
// but we need to make sure there is no string in node data
|
|
185
|
searchexpr = nodedataterm + " " + oper + " "
|
|
186
|
+ new Double(casevalue) + " ";
|
|
187
|
} catch (NumberFormatException nfe) {
|
|
188
|
// these are characters; character comparison
|
|
189
|
searchexpr = nodedataterm + " " + oper + " '" + casevalue
|
|
190
|
+ "' ";
|
|
191
|
}
|
|
192
|
}
|
|
193
|
|
|
194
|
|
|
195
|
// to check xml_path_index can be used
|
|
196
|
boolean usePathIndex = false;
|
|
197
|
|
|
198
|
// if pathexpr has been specified in metacat.properties for indexing
|
|
199
|
if(pathexpr != null){
|
|
200
|
if(MetaCatUtil.pathsForIndexing.contains(pathexpr)){
|
|
201
|
usePathIndex = true;
|
|
202
|
}
|
|
203
|
}
|
|
204
|
|
|
205
|
if(usePathIndex){
|
|
206
|
// using xml_path_index table.....
|
|
207
|
if(notEqual == true){
|
|
208
|
self.append("SELECT DISTINCT docid from xml_path_index WHERE");
|
|
209
|
self.append(" docid NOT IN (Select docid FROM xml_path_index WHERE ");
|
|
210
|
self.append(searchexpr);
|
|
211
|
self.append("AND path LIKE '" + pathexpr + "') ");
|
|
212
|
} else {
|
|
213
|
self.append("SELECT DISTINCT docid FROM xml_path_index WHERE ");
|
|
214
|
self.append(searchexpr);
|
|
215
|
self.append("AND path LIKE '" + pathexpr + "' ");
|
|
216
|
}
|
|
217
|
|
|
218
|
} else {
|
|
219
|
// using xml_nodes and xml_index tables
|
|
220
|
|
|
221
|
if(notEqual == true){
|
|
222
|
self.append("SELECT DISTINCT docid from xml_nodes WHERE");
|
|
223
|
self.append(" docid NOT IN (Select docid FROM xml_nodes WHERE ");
|
|
224
|
} else {
|
|
225
|
self.append("(SELECT DISTINCT docid FROM xml_nodes WHERE ");
|
|
226
|
}
|
|
227
|
self.append(searchexpr);
|
|
228
|
|
|
229
|
if (pathexpr != null) {
|
|
230
|
|
|
231
|
// use XML Index
|
|
232
|
if (useXMLIndex) {
|
|
233
|
if (!hasAttributeInPath(pathexpr)) {
|
|
234
|
// without attributes in path
|
|
235
|
self.append("AND parentnodeid IN ");
|
|
236
|
} else {
|
|
237
|
// has a attribute in path
|
|
238
|
String attributeName = QuerySpecification
|
|
239
|
.getAttributeName(pathexpr);
|
|
240
|
self.append(
|
|
241
|
"AND nodetype LIKE 'ATTRIBUTE' AND nodename LIKE '"
|
|
242
|
+ attributeName + "' ");
|
|
243
|
// and the path expression includes element content other than
|
|
244
|
// just './' or '../'
|
|
245
|
if ( (!pathexpr.startsWith(QuerySpecification.
|
|
246
|
ATTRIBUTESYMBOL)) &&
|
|
247
|
(!pathexpr.startsWith("./" +
|
|
248
|
QuerySpecification.ATTRIBUTESYMBOL)) &&
|
|
249
|
(!pathexpr.startsWith("../" +
|
|
250
|
QuerySpecification.ATTRIBUTESYMBOL))) {
|
|
251
|
|
|
252
|
self.append("AND parentnodeid IN ");
|
|
253
|
pathexpr = QuerySpecification
|
|
254
|
.newPathExpressionWithOutAttribute(pathexpr);
|
|
255
|
}
|
|
256
|
}
|
|
257
|
self.append(
|
|
258
|
"(SELECT nodeid FROM xml_index WHERE path LIKE "
|
|
259
|
+ "'" + pathexpr + "') ");
|
|
260
|
}
|
|
261
|
else {
|
|
262
|
// without using XML Index; using nested statements instead
|
|
263
|
self.append("AND parentnodeid IN ");
|
|
264
|
self.append(useNestedStatements(pathexpr));
|
|
265
|
}
|
|
266
|
}
|
|
267
|
else if ( (value.trim()).equals("%")) {
|
|
268
|
//if pathexpr is null and search value is %, is a
|
|
269
|
// percentageSearchItem
|
|
270
|
// the count number will be increase one
|
|
271
|
countPercentageSearchItem++;
|
|
272
|
|
|
273
|
}
|
|
274
|
self.append(") ");
|
|
275
|
}
|
|
276
|
|
|
277
|
return self.toString();
|
|
278
|
}
|
|
279
|
|
|
280
|
/** A method to judge if a path have attribute */
|
|
281
|
private boolean hasAttributeInPath(String path)
|
|
282
|
{
|
|
283
|
if (path.indexOf(QuerySpecification.ATTRIBUTESYMBOL) != -1) {
|
|
284
|
return true;
|
|
285
|
} else {
|
|
286
|
return false;
|
|
287
|
}
|
|
288
|
}
|
|
289
|
|
|
290
|
/*
|
|
291
|
* Constraint the query with @pathexp without using the XML Index, but
|
|
292
|
* nested SQL statements instead. The query migth be slower.
|
|
293
|
*/
|
|
294
|
public static String useNestedStatements(String pathexpr)
|
|
295
|
{
|
|
296
|
StringBuffer nestedStmts = new StringBuffer();
|
|
297
|
Vector nodes = new Vector();
|
|
298
|
String path = pathexpr;
|
|
299
|
int inx = 0;
|
|
300
|
|
|
301
|
do {
|
|
302
|
inx = path.lastIndexOf("/");
|
|
303
|
|
|
304
|
nodes.addElement(path.substring(inx + 1));
|
|
305
|
path = path.substring(0, Math.abs(inx));
|
|
306
|
} while (inx > 0);
|
|
307
|
|
|
308
|
// nested statements
|
|
309
|
int i = 0;
|
|
310
|
for (i = 0; i < nodes.size() - 1; i++) {
|
|
311
|
nestedStmts.append("(SELECT nodeid FROM xml_nodes"
|
|
312
|
+ " WHERE nodename LIKE '" + (String) nodes.elementAt(i)
|
|
313
|
+ "'" + " AND parentnodeid IN ");
|
|
314
|
}
|
|
315
|
// for the last statement: it is without " AND parentnodeid IN "
|
|
316
|
nestedStmts.append("(SELECT nodeid FROM xml_nodes"
|
|
317
|
+ " WHERE nodename LIKE '" + (String) nodes.elementAt(i) + "'");
|
|
318
|
// node.size() number of closing brackets
|
|
319
|
for (i = 0; i < nodes.size(); i++) {
|
|
320
|
nestedStmts.append(")");
|
|
321
|
}
|
|
322
|
|
|
323
|
return nestedStmts.toString();
|
|
324
|
}
|
|
325
|
|
|
326
|
/**
|
|
327
|
* create a String description of the query that this instance represents.
|
|
328
|
* This should become a way to get the XML serialization of the query.
|
|
329
|
*/
|
|
330
|
public String toString()
|
|
331
|
{
|
|
332
|
|
|
333
|
return this.printSQL(true);
|
|
334
|
}
|
|
335
|
}
|