-
Notifications
You must be signed in to change notification settings - Fork 0
/
InspectIndex.java
441 lines (351 loc) · 11.2 KB
/
InspectIndex.java
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
/*
* Copyright (c) 2016, Carnegie Mellon University. All Rights Reserved.
*/
import java.io.*;
import java.util.*;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.*;
import org.apache.lucene.util.*;
import org.apache.lucene.search.*;
import org.apache.lucene.store.*;
/**
* A simple utility for inspecting Lucene indexes. Run it to see a
* simple usage message.
*/
public class InspectIndex {
static String usage =
"Usage: java " +
System.getProperty("sun.java.command") +
" -index INDEX_PATH\n\n" +
"where options include\n" +
" -list-docids\tlist the external docids of each document\n" +
" -list-edocid IDOCID\n" +
"\t\t\tlist the external docid of the document\n" +
"\t\t\twith internal docid of IDOCID\n" +
" -list-fields\tlist the fields in the index\n" +
" -list-postings TERM FIELD\n" +
"\t\t\tdisplay the posting list entries for\n" +
"\t\t\tterm TERM in field FIELD\n" +
" -list-postings-sample TERM FIELD\n" +
"\t\t\tdisplay the first few posting list entries for\n" +
"\t\t\tterm TERM in field FIELD\n" +
" -list-stats\n" +
"\t\t\tdisplay corpus statistics\n" +
" -list-terms FIELD" +
"\tdisplay the term dictionary for field FIELD\n" +
" -list-termvector DOCID\n" +
"\t\t\tdisplay the term vectors for all fields in the document\n" +
"\t\t\twith internal DOCID\n" +
" -list-termvector-field DOCID FIELD\n" +
"\t\t\tdisplay the term vector for FIELD in the document\n" +
"\t\t\twith internal DOCID\n";
public static void main(String[] args) throws IOException {
IndexReader reader = null;
/*
* Opening the index first simplifies the processing of the
* rest of the command line arguments.
*/
for (int i=0; i < args.length; i++) {
if (("-index".equals (args[i])) &&
((i+1) < args.length)) {
reader = DirectoryReader.open (
FSDirectory.open (new File (args[i+1])));
if (reader == null) {
System.err.println ("Error: Can't open index " +
args[i+1]);
System.exit (1);
};
break;
};
};
if (reader == null) {
System.err.println (usage);
System.exit (1);
};
/*
* Process the command line arguments sequentially.
*/
for (int i=0; i < args.length; i++) {
if ("-index".equals(args[i])) {
/*
* Handled in the previous loop, so just skip the argument.
*/
i++;
} else if ("-list-edocid".equals(args[i])) {
System.out.println ("-list-edocid:");
if ((i+1) >= args.length) {
System.out.println (usage);
break;
};
Document d = reader.document (Integer.parseInt (args[i+1]));
System.out.println ("Internal docid --> External docid: " +
args[i+1] + " --> " + d.get ("externalId"));
i += 1;
} else if ("-list-docids".equals(args[i])) {
System.out.println ("-list-docids:");
for (int j=0; j<reader.numDocs(); j++) {
Document d = reader.document (j);
System.out.println ("Internal --> external docid: " +
j + " --> " + d.get ("externalId"));
};
} else if ("-list-fields".equals(args[i])) {
Fields fields = MultiFields.getFields (reader);
System.out.print ("\nNumber of fields: ");
if (fields == null)
System.out.println ("0");
else {
System.out.println (fields.size());
Iterator<String> is = fields.iterator();
while (is.hasNext()) {
System.out.println ("\t" + is.next());
};
};
} else if ("-list-postings".equals(args[i])) {
if ((i+2) >= args.length) {
System.out.println (usage);
break;
};
listPostings (reader, args[i+1], args [i+2],
Integer.MAX_VALUE);
i += 2;
} else if ("-list-postings-sample".equals(args[i])) {
if ((i+2) >= args.length) {
System.out.println (usage);
break;
};
listPostings (reader, args[i+1], args [i+2], 5);
i += 2;
} else if ("-list-stats".equals(args[i])) {
System.out.println ("Corpus statistics:");
System.out.println ("\tnumdocs\t\t" + reader.numDocs());
System.out.println ("\turl:\t" +
"\tnumdocs=" +
reader.getDocCount ("url") +
"\tsumTotalTF=" +
reader.getSumTotalTermFreq("url") +
"\tavglen="+
reader.getSumTotalTermFreq("url") /
(float) reader.getDocCount ("url"));
System.out.println ("\tkeywords:" +
"\tnumdocs=" +
reader.getDocCount ("keywords") +
"\tsumTotalTF=" +
reader.getSumTotalTermFreq("keywords") +
"\tavglen="+
reader.getSumTotalTermFreq("keywords") /
(float) reader.getDocCount ("keywords"));
System.out.println ("\ttitle:\t" +
"\tnumdocs=" +
reader.getDocCount ("title") +
"\tsumTotalTF=" +
reader.getSumTotalTermFreq("title") +
"\tavglen="+
reader.getSumTotalTermFreq("title") /
(float) reader.getDocCount ("title"));
System.out.println ("\tbody:\t" +
"\tnumdocs=" +
reader.getDocCount ("body") +
"\tsumTotalTF=" +
reader.getSumTotalTermFreq("body") +
"\tavglen="+
reader.getSumTotalTermFreq("body") /
(float) reader.getDocCount ("body"));
System.out.println ("\tinlink:\t" +
"\tnumdocs=" +
reader.getDocCount ("inlink") +
"\tsumTotalTF=" +
reader.getSumTotalTermFreq("inlink") +
"\tavglen="+
reader.getSumTotalTermFreq("inlink") /
(float) reader.getDocCount ("inlink"));
} else if ("-list-terms".equals(args[i])) {
if ((i+1) >= args.length) {
System.out.println (usage);
break;
};
listTermDictionary (reader, args[i+1]);
i += 1;
} else if ("-list-termvector".equals(args[i])) {
if ((i+1) >= args.length) {
System.out.println (usage);
break;
};
listTermVectors (reader, args[i+1]);
i += 1;
} else if ("-list-termvector-field".equals(args[i])) {
if ((i+2) >= args.length) {
System.out.println (usage);
break;
};
listTermVectorField (reader, args[i+1], args[i+2]);
i += 2;
} else
System.err.println ("\nWarning: Unknown argument " + args[i]
+ " ignored.");
};
/*
* Close the index and exit gracefully.
*/
reader.close();
}
/*
* listPostings displays the first n postings for a term in a
* field in an index (specified by reader). Set n to MAX_VALUE
* to display all postings.
*/
static void listPostings (IndexReader reader, String termString,
String field, Integer n) throws IOException {
System.out.println ("\nPostings: " + termString + " " + field);
/*
* Prepare to access the index.
*/
BytesRef termBytes = new BytesRef (termString);
Term term = new Term (field, termBytes);
Bits liveDocs = MultiFields.getLiveDocs (reader);
/*
* Lookup the collection term frequency (ctf).
*/
long df = reader.docFreq (term);
System.out.println ("\tdf: " + df);
long ctf = reader.totalTermFreq (term);
System.out.println ("\tctf: " + ctf);
if (df < 1)
return;
/*
* Lookup the inverted list.
*/
DocsAndPositionsEnum postings =
MultiFields.getTermPositionsEnum (reader, liveDocs, field,
termBytes);
/*
* Iterate through the first n postings.
*/
long count = 0;
while ((count < n) &&
(postings.nextDoc() != DocIdSetIterator.NO_MORE_DOCS)) {
System.out.println ("\tdocid: " + postings.docID());
int tf = postings.freq();
System.out.println("\ttf: " + tf);
System.out.print("\tPositions: ");
for (int j=0; j<tf; j++) {
int pos = postings.nextPosition();
System.out.print (pos + " ");
}
System.out.println ("");
count++;
};
return;
}
/*
* listTermDictionary displays the term dictionary for a field.
*/
static void listTermDictionary (IndexReader reader, String fieldName)
throws IOException {
System.out.println ("\nTerm Dictionary: field " + fieldName);
/*
Grant says:
MultiFields.getTerms(IndexReader, fieldName)
*/
Terms terms = MultiFields.getTerms(reader, fieldName);
if ((terms == null) ||
(terms.size () == -1))
System.out.println (" The term dictionary is empty.");
else {
System.out.println (" Vocabulary size: " +
terms.size () + " terms");
TermsEnum ithTerm = terms.iterator (null);
/*
* Iterate over the terms in this document.
* Information about a term's occurrences (tf and
* positions) is accessed via the indexing API, which
* returns inverted lists that describe (only) the
* current document.
*/
while (ithTerm.next() != null){
System.out.format (" %-30s %d %d\n",
ithTerm.term().utf8ToString(),
ithTerm.docFreq (),
ithTerm.totalTermFreq ());
};
};
}
/*
* listTermVectors displays the term vectors for all of the fields
* in a document in an index (specified by reader).
*/
static void listTermVectors (IndexReader reader, String docidString)
throws IOException {
System.out.println ("\nTermVector: docid " + docidString);
int docid = Integer.parseInt (docidString);
if ((docid < 0) ||
(docid >= reader.numDocs ())) {
System.out.println ("ERROR: " +
docidString + " is a bad document id.");
return;
};
/*
* Iterate over the fields in this document.
*/
Fields fields = reader.getTermVectors (docid);
Iterator<String> fieldIterator = fields.iterator ();
while (fieldIterator.hasNext()) {
String fieldName = fieldIterator.next();
System.out.println (" Field: " + fieldName);
Terms terms = fields.terms (fieldName);
termVectorDisplay (terms);
};
}
/*
* listTermVectorField displays the term vector for a field in
* a document in an index (specified by reader).
*/
static void listTermVectorField (IndexReader reader,
String docidString,
String field) throws IOException {
System.out.println ("\nTermVector: docid " +
docidString + ", field " + field);
int docid = Integer.parseInt (docidString);
if ((docid < 0) ||
(docid >= reader.numDocs ())) {
System.out.println ("ERROR: " +
docidString + " is a bad document id.");
return;
};
Terms terms = reader.getTermVector (docid, field);
termVectorDisplay (terms);
}
/*
* Utility function to display a term vector.
*/
static void termVectorDisplay (Terms terms) throws IOException {
if ((terms == null) ||
(terms.size () == -1))
System.out.println (" The field is not stored.");
else {
/*
* The terms for this field are stored.
*/
System.out.println (" Vocabulary size: " +
terms.size () + " terms");
TermsEnum ithTerm = terms.iterator (null);
/*
* Iterate over the terms in this document.
* Information about a term's occurrences (tf and
* positions) is accessed via the indexing API, which
* returns inverted lists that describe (only) the
* current document.
*/
while (ithTerm.next() != null){
System.out.format (" %10d %-20s %d ",
ithTerm.ord(),
ithTerm.term().utf8ToString(),
ithTerm.totalTermFreq ());
DocsAndPositionsEnum currDoc = ithTerm.docsAndPositions (null, null);
currDoc.nextDoc ();
for (int jthPosition=0; jthPosition<ithTerm.totalTermFreq(); jthPosition++)
System.out.print (currDoc.nextPosition () + " ");
System.out.println ();
};
};
}
}