← Back to branch summary

~slub.team/goobi-indexserver/3.x

« back to all changes in this revision

Viewing changes to lucene/backwards/src/test/org/apache/lucene/index/TestIndexReaderCloneNorms.java

  • Committer: Sebastian Meyer
  • Date: 2012-08-03 09:12:40 UTC
  • Revision ID: sebastian.meyer@slub-dresden.de-20120803091240-x6861b0vabq1xror
https://launchpad.net/bugs/985487
Remove Lucene and Solr source code and add patches instead
Fix Bug #985487: Auto-suggestion for the search interface

Show diffs side-by-side

added added

removed removed

Lines of Context:
lucene/backwards/src/test/org/apache/lucene/index/TestIndexReaderCloneNorms.java
1
 
package org.apache.lucene.index;
2
 
 
3
 
/**
4
 
 * Licensed to the Apache Software Foundation (ASF) under one or more
5
 
 * contributor license agreements.  See the NOTICE file distributed with
6
 
 * this work for additional information regarding copyright ownership.
7
 
 * The ASF licenses this file to You under the Apache License, Version 2.0
8
 
 * (the "License"); you may not use this file except in compliance with
9
 
 * the License.  You may obtain a copy of the License at
10
 
 *
11
 
 *     http://www.apache.org/licenses/LICENSE-2.0
12
 
 *
13
 
 * Unless required by applicable law or agreed to in writing, software
14
 
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 
 * See the License for the specific language governing permissions and
17
 
 * limitations under the License.
18
 
 */
19
 
 
20
 
import java.io.IOException;
21
 
import java.util.ArrayList;
22
 
import java.util.Random;
23
 
 
24
 
import java.util.concurrent.atomic.AtomicInteger;
25
 
import org.apache.lucene.analysis.Analyzer;
26
 
import org.apache.lucene.analysis.MockAnalyzer;
27
 
import org.apache.lucene.document.Document;
28
 
import org.apache.lucene.document.Field;
29
 
import org.apache.lucene.document.Field.Index;
30
 
import org.apache.lucene.document.Field.Store;
31
 
import org.apache.lucene.index.IndexWriterConfig.OpenMode;
32
 
import org.apache.lucene.index.SegmentNorms;
33
 
import org.apache.lucene.search.DefaultSimilarity;
34
 
import org.apache.lucene.search.Similarity;
35
 
import org.apache.lucene.store.Directory;
36
 
import org.apache.lucene.util.LuceneTestCase;
37
 
 
38
 
/**
39
 
 * Tests cloning IndexReader norms
40
 
 */
41
 
public class TestIndexReaderCloneNorms extends LuceneTestCase {
42
 
 
43
 
  private class SimilarityOne extends DefaultSimilarity {
44
 
    @Override
45
 
    public float computeNorm(String fieldName, FieldInvertState state) {
46
 
      // diable length norm
47
 
      return state.getBoost();
48
 
    }
49
 
  }
50
 
 
51
 
  private static final int NUM_FIELDS = 10;
52
 
 
53
 
  private Similarity similarityOne;
54
 
 
55
 
  private Analyzer anlzr;
56
 
 
57
 
  private int numDocNorms;
58
 
 
59
 
  private ArrayList<Float> norms;
60
 
 
61
 
  private ArrayList<Float> modifiedNorms;
62
 
 
63
 
  private float lastNorm = 0;
64
 
 
65
 
  private float normDelta = (float) 0.001;
66
 
 
67
 
  @Override
68
 
  public void setUp() throws Exception {
69
 
    super.setUp();
70
 
    similarityOne = new SimilarityOne();
71
 
    anlzr = new MockAnalyzer(random);
72
 
  }
73
 
  
74
 
  /**
75
 
   * Test that norms values are preserved as the index is maintained. Including
76
 
   * separate norms. Including merging indexes with seprate norms. Including
77
 
   * optimize.
78
 
   */
79
 
  public void testNorms() throws IOException {
80
 
    // test with a single index: index1
81
 
    Directory dir1 = newDirectory();
82
 
    IndexWriter.unlock(dir1);
83
 
 
84
 
    norms = new ArrayList<Float>();
85
 
    modifiedNorms = new ArrayList<Float>();
86
 
 
87
 
    createIndex(random, dir1);
88
 
    doTestNorms(random, dir1);
89
 
 
90
 
    // test with a single index: index2
91
 
    ArrayList<Float> norms1 = norms;
92
 
    ArrayList<Float> modifiedNorms1 = modifiedNorms;
93
 
    int numDocNorms1 = numDocNorms;
94
 
 
95
 
    norms = new ArrayList<Float>();
96
 
    modifiedNorms = new ArrayList<Float>();
97
 
    numDocNorms = 0;
98
 
 
99
 
    Directory dir2 = newDirectory();
100
 
 
101
 
    createIndex(random, dir2);
102
 
    doTestNorms(random, dir2);
103
 
 
104
 
    // add index1 and index2 to a third index: index3
105
 
    Directory dir3 = newDirectory();
106
 
 
107
 
    createIndex(random, dir3);
108
 
    IndexWriter iw = new IndexWriter(dir3, newIndexWriterConfig(
109
 
        TEST_VERSION_CURRENT, anlzr).setOpenMode(OpenMode.APPEND)
110
 
                                     .setMaxBufferedDocs(5).setMergePolicy(newLogMergePolicy(3)));
111
 
    iw.addIndexes(new Directory[] { dir1, dir2 });
112
 
    iw.optimize();
113
 
    iw.close();
114
 
 
115
 
    norms1.addAll(norms);
116
 
    norms = norms1;
117
 
    modifiedNorms1.addAll(modifiedNorms);
118
 
    modifiedNorms = modifiedNorms1;
119
 
    numDocNorms += numDocNorms1;
120
 
 
121
 
    // test with index3
122
 
    verifyIndex(dir3);
123
 
    doTestNorms(random, dir3);
124
 
 
125
 
    // now with optimize
126
 
    iw = new IndexWriter(dir3, newIndexWriterConfig( TEST_VERSION_CURRENT,
127
 
                                                     anlzr).setOpenMode(OpenMode.APPEND).setMaxBufferedDocs(5).setMergePolicy(newLogMergePolicy(3)));
128
 
    iw.optimize();
129
 
    iw.close();
130
 
    verifyIndex(dir3);
131
 
 
132
 
    dir1.close();
133
 
    dir2.close();
134
 
    dir3.close();
135
 
  }
136
 
 
137
 
  // try cloning and reopening the norms
138
 
  private void doTestNorms(Random random, Directory dir) throws IOException {
139
 
    addDocs(random, dir, 12, true);
140
 
    IndexReader ir = IndexReader.open(dir, false);
141
 
    verifyIndex(ir);
142
 
    modifyNormsForF1(ir);
143
 
    IndexReader irc = (IndexReader) ir.clone();// IndexReader.open(dir, false);//ir.clone();
144
 
    verifyIndex(irc);
145
 
 
146
 
    modifyNormsForF1(irc);
147
 
 
148
 
    IndexReader irc3 = (IndexReader) irc.clone();
149
 
    verifyIndex(irc3);
150
 
    modifyNormsForF1(irc3);
151
 
    verifyIndex(irc3);
152
 
    irc3.flush();
153
 
    irc3.close();
154
 
    
155
 
    irc.close();
156
 
    ir.close();
157
 
  }
158
 
  
159
 
  public void testNormsClose() throws IOException { 
160
 
    Directory dir1 = newDirectory(); 
161
 
    TestIndexReaderReopen.createIndex(random, dir1, false);
162
 
    SegmentReader reader1 = SegmentReader.getOnlySegmentReader(dir1);
163
 
    reader1.norms("field1");
164
 
    SegmentNorms r1norm = reader1.norms.get("field1");
165
 
    AtomicInteger r1BytesRef = r1norm.bytesRef();
166
 
    SegmentReader reader2 = (SegmentReader)reader1.clone();
167
 
    assertEquals(2, r1norm.bytesRef().get());
168
 
    reader1.close();
169
 
    assertEquals(1, r1BytesRef.get());
170
 
    reader2.norms("field1");
171
 
    reader2.close();
172
 
    dir1.close();
173
 
  }
174
 
  
175
 
  public void testNormsRefCounting() throws IOException { 
176
 
    Directory dir1 = newDirectory(); 
177
 
    TestIndexReaderReopen.createIndex(random, dir1, false);
178
 
    IndexReader reader1 = IndexReader.open(dir1, false);
179
 
        
180
 
    IndexReader reader2C = (IndexReader) reader1.clone();
181
 
    SegmentReader segmentReader2C = SegmentReader.getOnlySegmentReader(reader2C);
182
 
    segmentReader2C.norms("field1"); // load the norms for the field
183
 
    SegmentNorms reader2CNorm = segmentReader2C.norms.get("field1");
184
 
    assertTrue("reader2CNorm.bytesRef()=" + reader2CNorm.bytesRef(), reader2CNorm.bytesRef().get() == 2);
185
 
    
186
 
    
187
 
    
188
 
    IndexReader reader3C = (IndexReader) reader2C.clone();
189
 
    SegmentReader segmentReader3C = SegmentReader.getOnlySegmentReader(reader3C);
190
 
    SegmentNorms reader3CCNorm = segmentReader3C.norms.get("field1");
191
 
    assertEquals(3, reader3CCNorm.bytesRef().get());
192
 
    
193
 
    // edit a norm and the refcount should be 1
194
 
    IndexReader reader4C = (IndexReader) reader3C.clone();
195
 
    SegmentReader segmentReader4C = SegmentReader.getOnlySegmentReader(reader4C);
196
 
    assertEquals(4, reader3CCNorm.bytesRef().get());
197
 
    reader4C.setNorm(5, "field1", 0.33f);
198
 
    
199
 
    // generate a cannot update exception in reader1
200
 
    try {
201
 
      reader3C.setNorm(1, "field1", 0.99f);
202
 
      fail("did not hit expected exception");
203
 
    } catch (Exception ex) {
204
 
      // expected
205
 
    }
206
 
    
207
 
    // norm values should be different 
208
 
    assertTrue(Similarity.getDefault().decodeNormValue(segmentReader3C.norms("field1")[5]) 
209
 
                != Similarity.getDefault().decodeNormValue(segmentReader4C.norms("field1")[5]));
210
 
    SegmentNorms reader4CCNorm = segmentReader4C.norms.get("field1");
211
 
    assertEquals(3, reader3CCNorm.bytesRef().get());
212
 
    assertEquals(1, reader4CCNorm.bytesRef().get());
213
 
        
214
 
    IndexReader reader5C = (IndexReader) reader4C.clone();
215
 
    SegmentReader segmentReader5C = SegmentReader.getOnlySegmentReader(reader5C);
216
 
    SegmentNorms reader5CCNorm = segmentReader5C.norms.get("field1");
217
 
    reader5C.setNorm(5, "field1", 0.7f);
218
 
    assertEquals(1, reader5CCNorm.bytesRef().get());
219
 
 
220
 
    reader5C.close();
221
 
    reader4C.close();
222
 
    reader3C.close();
223
 
    reader2C.close();
224
 
    reader1.close();
225
 
    dir1.close();
226
 
  }
227
 
  
228
 
  private void createIndex(Random random, Directory dir) throws IOException {
229
 
    IndexWriter iw = new IndexWriter(dir, newIndexWriterConfig(
230
 
        TEST_VERSION_CURRENT, anlzr).setOpenMode(OpenMode.CREATE)
231
 
                                     .setMaxBufferedDocs(5).setSimilarity(similarityOne).setMergePolicy(newLogMergePolicy()));
232
 
    setUseCompoundFile(iw.getConfig().getMergePolicy(), true);
233
 
    setMergeFactor(iw.getConfig().getMergePolicy(), 3);
234
 
    iw.close();
235
 
  }
236
 
 
237
 
  private void modifyNormsForF1(IndexReader ir) throws IOException {
238
 
    int n = ir.maxDoc();
239
 
    // System.out.println("modifyNormsForF1 maxDoc: "+n);
240
 
    for (int i = 0; i < n; i += 3) { // modify for every third doc
241
 
      int k = (i * 3) % modifiedNorms.size();
242
 
      float origNorm =  modifiedNorms.get(i).floatValue();
243
 
      float newNorm =  modifiedNorms.get(k).floatValue();
244
 
      // System.out.println("Modifying: for "+i+" from "+origNorm+" to
245
 
      // "+newNorm);
246
 
      // System.out.println(" and: for "+k+" from "+newNorm+" to "+origNorm);
247
 
      modifiedNorms.set(i, Float.valueOf(newNorm));
248
 
      modifiedNorms.set(k, Float.valueOf(origNorm));
249
 
      ir.setNorm(i, "f" + 1, newNorm);
250
 
      ir.setNorm(k, "f" + 1, origNorm);
251
 
      // System.out.println("setNorm i: "+i);
252
 
      // break;
253
 
    }
254
 
    // ir.close();
255
 
  }
256
 
 
257
 
  private void verifyIndex(Directory dir) throws IOException {
258
 
    IndexReader ir = IndexReader.open(dir, false);
259
 
    verifyIndex(ir);
260
 
    ir.close();
261
 
  }
262
 
 
263
 
  private void verifyIndex(IndexReader ir) throws IOException {
264
 
    for (int i = 0; i < NUM_FIELDS; i++) {
265
 
      String field = "f" + i;
266
 
      byte b[] = ir.norms(field);
267
 
      assertEquals("number of norms mismatches", numDocNorms, b.length);
268
 
      ArrayList<Float> storedNorms = (i == 1 ? modifiedNorms : norms);
269
 
      for (int j = 0; j < b.length; j++) {
270
 
        float norm = Similarity.getDefault().decodeNormValue(b[j]);
271
 
        float norm1 =  storedNorms.get(j).floatValue();
272
 
        assertEquals("stored norm value of " + field + " for doc " + j + " is "
273
 
            + norm + " - a mismatch!", norm, norm1, 0.000001);
274
 
      }
275
 
    }
276
 
  }
277
 
 
278
 
  private void addDocs(Random random, Directory dir, int ndocs, boolean compound)
279
 
      throws IOException {
280
 
    IndexWriterConfig conf = newIndexWriterConfig(
281
 
            TEST_VERSION_CURRENT, anlzr).setOpenMode(OpenMode.APPEND)
282
 
      .setMaxBufferedDocs(5).setSimilarity(similarityOne).setMergePolicy(newLogMergePolicy());
283
 
    LogMergePolicy lmp = (LogMergePolicy) conf.getMergePolicy();
284
 
    lmp.setMergeFactor(3);
285
 
    lmp.setUseCompoundFile(compound);
286
 
    IndexWriter iw = new IndexWriter(dir, conf);
287
 
    for (int i = 0; i < ndocs; i++) {
288
 
      iw.addDocument(newDoc());
289
 
    }
290
 
    iw.close();
291
 
  }
292
 
 
293
 
  // create the next document
294
 
  private Document newDoc() {
295
 
    Document d = new Document();
296
 
    float boost = nextNorm();
297
 
    for (int i = 0; i < 10; i++) {
298
 
      Field f = newField("f" + i, "v" + i, Store.NO, Index.NOT_ANALYZED);
299
 
      f.setBoost(boost);
300
 
      d.add(f);
301
 
    }
302
 
    return d;
303
 
  }
304
 
 
305
 
  // return unique norm values that are unchanged by encoding/decoding
306
 
  private float nextNorm() {
307
 
    float norm = lastNorm + normDelta;
308
 
    do {
309
 
      float norm1 = Similarity.getDefault().decodeNormValue(
310
 
                  Similarity.getDefault().encodeNormValue(norm));
311
 
      if (norm1 > lastNorm) {
312
 
        // System.out.println(norm1+" > "+lastNorm);
313
 
        norm = norm1;
314
 
        break;
315
 
      }
316
 
      norm += normDelta;
317
 
    } while (true);
318
 
    norms.add(numDocNorms, Float.valueOf(norm));
319
 
    modifiedNorms.add(numDocNorms, Float.valueOf(norm));
320
 
    // System.out.println("creating norm("+numDocNorms+"): "+norm);
321
 
    numDocNorms++;
322
 
    lastNorm = (norm > 10 ? 0 : norm); // there's a limit to how many distinct
323
 
                                        // values can be stored in a ingle byte
324
 
    return norm;
325
 
  }
326
 
}