--- /dev/null
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.lucene.search.grouping;
+
+import java.io.IOException;
+import java.util.*;
+
+import org.apache.lucene.analysis.MockAnalyzer;
+import org.apache.lucene.document.Document;
+import org.apache.lucene.document.Field;
+import org.apache.lucene.document.NumericField;
+import org.apache.lucene.index.FieldInfo.IndexOptions;
+import org.apache.lucene.index.IndexReader;
+import org.apache.lucene.index.RandomIndexWriter;
+import org.apache.lucene.index.Term;
+import org.apache.lucene.search.*;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.util.LuceneTestCase;
+import org.apache.lucene.util.ReaderUtil;
+import org.apache.lucene.util._TestUtil;
+
+// TODO
+// - should test relevance sort too
+// - test null
+// - test ties
+// - test compound sort
+
+public class TestGrouping extends LuceneTestCase {
+
+ public void testBasic() throws Exception {
+
+ final String groupField = "author";
+
+ Directory dir = newDirectory();
+ RandomIndexWriter w = new RandomIndexWriter(
+ random,
+ dir,
+ newIndexWriterConfig(TEST_VERSION_CURRENT,
+ new MockAnalyzer(random)).setMergePolicy(newLogMergePolicy()));
+ // 0
+ Document doc = new Document();
+ doc.add(new Field(groupField, "author1", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("content", "random text", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("id", "1", Field.Store.YES, Field.Index.NO));
+ w.addDocument(doc);
+
+ // 1
+ doc = new Document();
+ doc.add(new Field(groupField, "author1", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("content", "some more random text", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("id", "2", Field.Store.YES, Field.Index.NO));
+ w.addDocument(doc);
+
+ // 2
+ doc = new Document();
+ doc.add(new Field(groupField, "author1", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("content", "some more random textual data", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("id", "3", Field.Store.YES, Field.Index.NO));
+ w.addDocument(doc);
+
+ // 3
+ doc = new Document();
+ doc.add(new Field(groupField, "author2", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("content", "some random text", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("id", "4", Field.Store.YES, Field.Index.NO));
+ w.addDocument(doc);
+
+ // 4
+ doc = new Document();
+ doc.add(new Field(groupField, "author3", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("content", "some more random text", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("id", "5", Field.Store.YES, Field.Index.NO));
+ w.addDocument(doc);
+
+ // 5
+ doc = new Document();
+ doc.add(new Field(groupField, "author3", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("content", "random", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("id", "6", Field.Store.YES, Field.Index.NO));
+ w.addDocument(doc);
+
+ // 6 -- no author field
+ doc = new Document();
+ doc.add(new Field("content", "random word stuck in alot of other text", Field.Store.YES, Field.Index.ANALYZED));
+ doc.add(new Field("id", "6", Field.Store.YES, Field.Index.NO));
+ w.addDocument(doc);
+
+ IndexSearcher indexSearcher = new IndexSearcher(w.getReader());
+ w.close();
+
+ final Sort groupSort = Sort.RELEVANCE;
+ final TermFirstPassGroupingCollector c1 = new TermFirstPassGroupingCollector(groupField, groupSort, 10);
+ indexSearcher.search(new TermQuery(new Term("content", "random")), c1);
+
+ final TermSecondPassGroupingCollector c2 = new TermSecondPassGroupingCollector(groupField, c1.getTopGroups(0, true), groupSort, null, 5, true, false, true);
+ indexSearcher.search(new TermQuery(new Term("content", "random")), c2);
+
+ final TopGroups groups = c2.getTopGroups(0);
+
+ assertEquals(7, groups.totalHitCount);
+ assertEquals(7, groups.totalGroupedHitCount);
+ assertEquals(4, groups.groups.length);
+
+ // relevance order: 5, 0, 3, 4, 1, 2, 6
+
+ // the later a document is added the higher this docId
+ // value
+ GroupDocs group = groups.groups[0];
+ assertEquals("author3", group.groupValue);
+ assertEquals(2, group.scoreDocs.length);
+ assertEquals(5, group.scoreDocs[0].doc);
+ assertEquals(4, group.scoreDocs[1].doc);
+ assertTrue(group.scoreDocs[0].score > group.scoreDocs[1].score);
+
+ group = groups.groups[1];
+ assertEquals("author1", group.groupValue);
+ assertEquals(3, group.scoreDocs.length);
+ assertEquals(0, group.scoreDocs[0].doc);
+ assertEquals(1, group.scoreDocs[1].doc);
+ assertEquals(2, group.scoreDocs[2].doc);
+ assertTrue(group.scoreDocs[0].score > group.scoreDocs[1].score);
+ assertTrue(group.scoreDocs[1].score > group.scoreDocs[2].score);
+
+ group = groups.groups[2];
+ assertEquals("author2", group.groupValue);
+ assertEquals(1, group.scoreDocs.length);
+ assertEquals(3, group.scoreDocs[0].doc);
+
+ group = groups.groups[3];
+ assertNull(group.groupValue);
+ assertEquals(1, group.scoreDocs.length);
+ assertEquals(6, group.scoreDocs[0].doc);
+
+ indexSearcher.getIndexReader().close();
+ dir.close();
+ }
+
+ private static class GroupDoc {
+ final int id;
+ final String group;
+ final String sort1;
+ final String sort2;
+ // content must be "realN ..."
+ final String content;
+ float score;
+ float score2;
+
+ public GroupDoc(int id, String group, String sort1, String sort2, String content) {
+ this.id = id;
+ this.group = group;
+ this.sort1 = sort1;
+ this.sort2 = sort2;
+ this.content = content;
+ }
+ }
+
+ private Sort getRandomSort() {
+ final List<SortField> sortFields = new ArrayList<SortField>();
+ if (random.nextInt(7) == 2) {
+ sortFields.add(SortField.FIELD_SCORE);
+ } else {
+ if (random.nextBoolean()) {
+ if (random.nextBoolean()) {
+ sortFields.add(new SortField("sort1", SortField.STRING, random.nextBoolean()));
+ } else {
+ sortFields.add(new SortField("sort2", SortField.STRING, random.nextBoolean()));
+ }
+ } else if (random.nextBoolean()) {
+ sortFields.add(new SortField("sort1", SortField.STRING, random.nextBoolean()));
+ sortFields.add(new SortField("sort2", SortField.STRING, random.nextBoolean()));
+ }
+ }
+ // Break ties:
+ sortFields.add(new SortField("id", SortField.INT));
+ return new Sort(sortFields.toArray(new SortField[sortFields.size()]));
+ }
+
+ private Comparator<GroupDoc> getComparator(Sort sort) {
+ final SortField[] sortFields = sort.getSort();
+ return new Comparator<GroupDoc>() {
+ // @Override -- Not until Java 1.6
+ public int compare(GroupDoc d1, GroupDoc d2) {
+ for(SortField sf : sortFields) {
+ final int cmp;
+ if (sf.getType() == SortField.SCORE) {
+ if (d1.score > d2.score) {
+ cmp = -1;
+ } else if (d1.score < d2.score) {
+ cmp = 1;
+ } else {
+ cmp = 0;
+ }
+ } else if (sf.getField().equals("sort1")) {
+ cmp = d1.sort1.compareTo(d2.sort1);
+ } else if (sf.getField().equals("sort2")) {
+ cmp = d1.sort2.compareTo(d2.sort2);
+ } else {
+ assertEquals(sf.getField(), "id");
+ cmp = d1.id - d2.id;
+ }
+ if (cmp != 0) {
+ return sf.getReverse() ? -cmp : cmp;
+ }
+ }
+ // Our sort always fully tie breaks:
+ fail();
+ return 0;
+ }
+ };
+ }
+
+ private Comparable<?>[] fillFields(GroupDoc d, Sort sort) {
+ final SortField[] sortFields = sort.getSort();
+ final Comparable<?>[] fields = new Comparable[sortFields.length];
+ for(int fieldIDX=0;fieldIDX<sortFields.length;fieldIDX++) {
+ final Comparable<?> c;
+ final SortField sf = sortFields[fieldIDX];
+ if (sf.getType() == SortField.SCORE) {
+ c = new Float(d.score);
+ } else if (sf.getField().equals("sort1")) {
+ c = d.sort1;
+ } else if (sf.getField().equals("sort2")) {
+ c = d.sort2;
+ } else {
+ assertEquals("id", sf.getField());
+ c = new Integer(d.id);
+ }
+ fields[fieldIDX] = c;
+ }
+ return fields;
+ }
+
+ private String groupToString(String b) {
+ if (b == null) {
+ return "null";
+ } else {
+ return b;
+ }
+ }
+
+ private TopGroups<String> slowGrouping(GroupDoc[] groupDocs,
+ String searchTerm,
+ boolean fillFields,
+ boolean getScores,
+ boolean getMaxScores,
+ boolean doAllGroups,
+ Sort groupSort,
+ Sort docSort,
+ int topNGroups,
+ int docsPerGroup,
+ int groupOffset,
+ int docOffset) {
+
+ final Comparator<GroupDoc> groupSortComp = getComparator(groupSort);
+
+ Arrays.sort(groupDocs, groupSortComp);
+ final HashMap<String,List<GroupDoc>> groups = new HashMap<String,List<GroupDoc>>();
+ final List<String> sortedGroups = new ArrayList<String>();
+ final List<Comparable<?>[]> sortedGroupFields = new ArrayList<Comparable<?>[]>();
+
+ int totalHitCount = 0;
+ Set<String> knownGroups = new HashSet<String>();
+
+ //System.out.println("TEST: slowGrouping");
+ for(GroupDoc d : groupDocs) {
+ // TODO: would be better to filter by searchTerm before sorting!
+ if (!d.content.startsWith(searchTerm)) {
+ continue;
+ }
+ totalHitCount++;
+
+ //System.out.println(" match id=" + d.id + " score=" + d.score);
+
+ if (doAllGroups) {
+ if (!knownGroups.contains(d.group)) {
+ knownGroups.add(d.group);
+ //System.out.println(" add group=" + groupToString(d.group));
+ }
+ }
+
+ List<GroupDoc> l = groups.get(d.group);
+ if (l == null) {
+ //System.out.println(" add sortedGroup=" + groupToString(d.group));
+ sortedGroups.add(d.group);
+ if (fillFields) {
+ sortedGroupFields.add(fillFields(d, groupSort));
+ }
+ l = new ArrayList<GroupDoc>();
+ groups.put(d.group, l);
+ }
+ l.add(d);
+ }
+
+ if (groupOffset >= sortedGroups.size()) {
+ // slice is out of bounds
+ return null;
+ }
+
+ final int limit = Math.min(groupOffset + topNGroups, groups.size());
+
+ final Comparator<GroupDoc> docSortComp = getComparator(docSort);
+ @SuppressWarnings("unchecked")
+ final GroupDocs<String>[] result = new GroupDocs[limit-groupOffset];
+ int totalGroupedHitCount = 0;
+ for(int idx=groupOffset;idx < limit;idx++) {
+ final String group = sortedGroups.get(idx);
+ final List<GroupDoc> docs = groups.get(group);
+ totalGroupedHitCount += docs.size();
+ Collections.sort(docs, docSortComp);
+ final ScoreDoc[] hits;
+ if (docs.size() > docOffset) {
+ final int docIDXLimit = Math.min(docOffset + docsPerGroup, docs.size());
+ hits = new ScoreDoc[docIDXLimit - docOffset];
+ for(int docIDX=docOffset; docIDX < docIDXLimit; docIDX++) {
+ final GroupDoc d = docs.get(docIDX);
+ final FieldDoc fd;
+ if (fillFields) {
+ fd = new FieldDoc(d.id, getScores ? d.score : Float.NaN, fillFields(d, docSort));
+ } else {
+ fd = new FieldDoc(d.id, getScores ? d.score : Float.NaN);
+ }
+ hits[docIDX-docOffset] = fd;
+ }
+ } else {
+ hits = new ScoreDoc[0];
+ }
+
+ result[idx-groupOffset] = new GroupDocs<String>(0.0f,
+ docs.size(),
+ hits,
+ group,
+ fillFields ? sortedGroupFields.get(idx) : null);
+ }
+
+ if (doAllGroups) {
+ return new TopGroups<String>(
+ new TopGroups<String>(groupSort.getSort(), docSort.getSort(), totalHitCount, totalGroupedHitCount, result),
+ knownGroups.size()
+ );
+ } else {
+ return new TopGroups<String>(groupSort.getSort(), docSort.getSort(), totalHitCount, totalGroupedHitCount, result);
+ }
+ }
+
+ private IndexReader getDocBlockReader(Directory dir, GroupDoc[] groupDocs) throws IOException {
+ // Coalesce by group, but in random order:
+ Collections.shuffle(Arrays.asList(groupDocs), random);
+ final Map<String,List<GroupDoc>> groupMap = new HashMap<String,List<GroupDoc>>();
+ final List<String> groupValues = new ArrayList<String>();
+
+ for(GroupDoc groupDoc : groupDocs) {
+ if (!groupMap.containsKey(groupDoc.group)) {
+ groupValues.add(groupDoc.group);
+ groupMap.put(groupDoc.group, new ArrayList<GroupDoc>());
+ }
+ groupMap.get(groupDoc.group).add(groupDoc);
+ }
+
+ RandomIndexWriter w = new RandomIndexWriter(
+ random,
+ dir,
+ newIndexWriterConfig(TEST_VERSION_CURRENT,
+ new MockAnalyzer(random)));
+
+ final List<List<Document>> updateDocs = new ArrayList<List<Document>>();
+
+ //System.out.println("TEST: index groups");
+ for(String group : groupValues) {
+ final List<Document> docs = new ArrayList<Document>();
+ //System.out.println("TEST: group=" + (group == null ? "null" : group.utf8ToString()));
+ for(GroupDoc groupValue : groupMap.get(group)) {
+ Document doc = new Document();
+ docs.add(doc);
+ if (groupValue.group != null) {
+ doc.add(newField("group", groupValue.group, Field.Index.NOT_ANALYZED));
+ }
+ doc.add(newField("sort1", groupValue.sort1, Field.Index.NOT_ANALYZED));
+ doc.add(newField("sort2", groupValue.sort2, Field.Index.NOT_ANALYZED));
+ doc.add(new NumericField("id").setIntValue(groupValue.id));
+ doc.add(newField("content", groupValue.content, Field.Index.ANALYZED));
+ //System.out.println("TEST: doc content=" + groupValue.content + " group=" + (groupValue.group == null ? "null" : groupValue.group.utf8ToString()) + " sort1=" + groupValue.sort1.utf8ToString() + " id=" + groupValue.id);
+ }
+ // So we can pull filter marking last doc in block:
+ final Field groupEnd = newField("groupend", "x", Field.Index.NOT_ANALYZED);
+ groupEnd.setIndexOptions(IndexOptions.DOCS_ONLY);
+ groupEnd.setOmitNorms(true);
+ docs.get(docs.size()-1).add(groupEnd);
+ // Add as a doc block:
+ w.addDocuments(docs);
+ if (group != null && random.nextInt(7) == 4) {
+ updateDocs.add(docs);
+ }
+ }
+
+ for(List<Document> docs : updateDocs) {
+ // Just replaces docs w/ same docs:
+ w.updateDocuments(new Term("group", docs.get(0).get("group")),
+ docs);
+ }
+
+ final IndexReader r = w.getReader();
+ w.close();
+
+ return r;
+ }
+
+ private static class ShardState {
+
+ public final ShardSearcher[] subSearchers;
+ public final int[] docStarts;
+
+ public ShardState(IndexSearcher s) {
+ IndexReader[] subReaders = s.getIndexReader().getSequentialSubReaders();
+ if (subReaders == null) {
+ subReaders = new IndexReader[] {s.getIndexReader()};
+ }
+ subSearchers = new ShardSearcher[subReaders.length];
+ for(int searcherIDX=0;searcherIDX<subSearchers.length;searcherIDX++) {
+ subSearchers[searcherIDX] = new ShardSearcher(subReaders[searcherIDX]);
+ }
+
+ docStarts = new int[subSearchers.length];
+ int docBase = 0;
+ for(int subIDX=0;subIDX<docStarts.length;subIDX++) {
+ docStarts[subIDX] = docBase;
+ docBase += subReaders[subIDX].maxDoc();
+ //System.out.println("docStarts[" + subIDX + "]=" + docStarts[subIDX]);
+ }
+ }
+ }
+
+ public void testRandom() throws Exception {
+ for(int iter=0;iter<3;iter++) {
+
+ if (VERBOSE) {
+ System.out.println("TEST: iter=" + iter);
+ }
+
+ final int numDocs = _TestUtil.nextInt(random, 100, 1000) * RANDOM_MULTIPLIER;
+ //final int numDocs = _TestUtil.nextInt(random, 5, 20);
+
+ final int numGroups = _TestUtil.nextInt(random, 1, numDocs);
+
+ if (VERBOSE) {
+ System.out.println("TEST: numDocs=" + numDocs + " numGroups=" + numGroups);
+ }
+
+ final List<String> groups = new ArrayList<String>();
+ for(int i=0;i<numGroups;i++) {
+ groups.add(_TestUtil.randomRealisticUnicodeString(random));
+ //groups.add(_TestUtil.randomUnicodeString(random));
+ assertEquals(-1, groups.get(groups.size()-1).indexOf(0xffff));
+ //groups.add(new BytesRef(_TestUtil.randomSimpleString(random)));
+ }
+ final String[] contentStrings = new String[_TestUtil.nextInt(random, 2, 20)];
+ if (VERBOSE) {
+ System.out.println("TEST: create fake content");
+ }
+ for(int contentIDX=0;contentIDX<contentStrings.length;contentIDX++) {
+ final StringBuilder sb = new StringBuilder();
+ sb.append("real" + random.nextInt(3)).append(' ');
+ final int fakeCount = random.nextInt(10);
+ for(int fakeIDX=0;fakeIDX<fakeCount;fakeIDX++) {
+ sb.append("fake ");
+ }
+ contentStrings[contentIDX] = sb.toString();
+ if (VERBOSE) {
+ System.out.println(" content=" + sb.toString());
+ }
+ }
+
+ Directory dir = newDirectory();
+ RandomIndexWriter w = new RandomIndexWriter(
+ random,
+ dir,
+ newIndexWriterConfig(TEST_VERSION_CURRENT,
+ new MockAnalyzer(random)));
+
+ Document doc = new Document();
+ Document docNoGroup = new Document();
+ Field group = newField("group", "", Field.Index.NOT_ANALYZED);
+ doc.add(group);
+ Field sort1 = newField("sort1", "", Field.Index.NOT_ANALYZED);
+ doc.add(sort1);
+ docNoGroup.add(sort1);
+ Field sort2 = newField("sort2", "", Field.Index.NOT_ANALYZED);
+ doc.add(sort2);
+ docNoGroup.add(sort2);
+ Field content = newField("content", "", Field.Index.ANALYZED);
+ doc.add(content);
+ docNoGroup.add(content);
+ NumericField id = new NumericField("id");
+ doc.add(id);
+ docNoGroup.add(id);
+ final GroupDoc[] groupDocs = new GroupDoc[numDocs];
+ for(int i=0;i<numDocs;i++) {
+ final String groupValue;
+ if (random.nextInt(24) == 17) {
+ // So we test the "doc doesn't have the group'd
+ // field" case:
+ groupValue = null;
+ } else {
+ groupValue = groups.get(random.nextInt(groups.size()));
+ }
+ final GroupDoc groupDoc = new GroupDoc(i,
+ groupValue,
+ groups.get(random.nextInt(groups.size())),
+ groups.get(random.nextInt(groups.size())),
+ contentStrings[random.nextInt(contentStrings.length)]);
+ if (VERBOSE) {
+ System.out.println(" doc content=" + groupDoc.content + " id=" + i + " group=" + (groupDoc.group == null ? "null" : groupDoc.group) + " sort1=" + groupDoc.sort1 + " sort2=" + groupDoc.sort2);
+ }
+
+ groupDocs[i] = groupDoc;
+ if (groupDoc.group != null) {
+ group.setValue(groupDoc.group);
+ }
+ sort1.setValue(groupDoc.sort1);
+ sort2.setValue(groupDoc.sort2);
+ content.setValue(groupDoc.content);
+ id.setIntValue(groupDoc.id);
+ if (groupDoc.group == null) {
+ w.addDocument(docNoGroup);
+ } else {
+ w.addDocument(doc);
+ }
+ }
+
+ final GroupDoc[] groupDocsByID = new GroupDoc[groupDocs.length];
+ System.arraycopy(groupDocs, 0, groupDocsByID, 0, groupDocs.length);
+
+ final IndexReader r = w.getReader();
+ w.close();
+
+ // NOTE: intentional but temporary field cache insanity!
+ final int[] docIDToID = FieldCache.DEFAULT.getInts(r, "id");
+ IndexReader rBlocks = null;
+ Directory dirBlocks = null;
+
+ try {
+ final IndexSearcher s = newSearcher(r);
+ final ShardState shards = new ShardState(s);
+
+ for(int contentID=0;contentID<3;contentID++) {
+ final ScoreDoc[] hits = s.search(new TermQuery(new Term("content", "real"+contentID)), numDocs).scoreDocs;
+ for(ScoreDoc hit : hits) {
+ final GroupDoc gd = groupDocs[docIDToID[hit.doc]];
+ assertTrue(gd.score == 0.0);
+ gd.score = hit.score;
+ assertEquals(gd.id, docIDToID[hit.doc]);
+ //System.out.println(" score=" + hit.score + " id=" + docIDToID[hit.doc]);
+ }
+ }
+
+ for(GroupDoc gd : groupDocs) {
+ assertTrue(gd.score != 0.0);
+ }
+
+ // Build 2nd index, where docs are added in blocks by
+ // group, so we can use single pass collector
+ dirBlocks = newDirectory();
+ rBlocks = getDocBlockReader(dirBlocks, groupDocs);
+ final Filter lastDocInBlock = new CachingWrapperFilter(new QueryWrapperFilter(new TermQuery(new Term("groupend", "x"))));
+ final int[] docIDToIDBlocks = FieldCache.DEFAULT.getInts(rBlocks, "id");
+
+ final IndexSearcher sBlocks = newSearcher(rBlocks);
+ final ShardState shardsBlocks = new ShardState(sBlocks);
+
+ // ReaderBlocks only increases maxDoc() vs reader, which
+ // means a monotonic shift in scores, so we can
+ // reliably remap them w/ Map:
+ final Map<String,Map<Float,Float>> scoreMap = new HashMap<String,Map<Float,Float>>();
+
+ // Tricky: must separately set .score2, because the doc
+ // block index was created with possible deletions!
+ //System.out.println("fixup score2");
+ for(int contentID=0;contentID<3;contentID++) {
+ //System.out.println(" term=real" + contentID);
+ final Map<Float,Float> termScoreMap = new HashMap<Float,Float>();
+ scoreMap.put("real"+contentID, termScoreMap);
+ //System.out.println("term=real" + contentID + " dfold=" + s.docFreq(new Term("content", "real"+contentID)) +
+ //" dfnew=" + sBlocks.docFreq(new Term("content", "real"+contentID)));
+ final ScoreDoc[] hits = sBlocks.search(new TermQuery(new Term("content", "real"+contentID)), numDocs).scoreDocs;
+ for(ScoreDoc hit : hits) {
+ final GroupDoc gd = groupDocsByID[docIDToIDBlocks[hit.doc]];
+ assertTrue(gd.score2 == 0.0);
+ gd.score2 = hit.score;
+ assertEquals(gd.id, docIDToIDBlocks[hit.doc]);
+ //System.out.println(" score=" + gd.score + " score2=" + hit.score + " id=" + docIDToIDBlocks[hit.doc]);
+ termScoreMap.put(gd.score, gd.score2);
+ }
+ }
+
+ for(int searchIter=0;searchIter<100;searchIter++) {
+
+ if (VERBOSE) {
+ System.out.println("\nTEST: searchIter=" + searchIter);
+ }
+
+ final String searchTerm = "real" + random.nextInt(3);
+ final boolean fillFields = random.nextBoolean();
+ boolean getScores = random.nextBoolean();
+ final boolean getMaxScores = random.nextBoolean();
+ final Sort groupSort = getRandomSort();
+ //final Sort groupSort = new Sort(new SortField[] {new SortField("sort1", SortField.STRING), new SortField("id", SortField.INT)});
+ // TODO: also test null (= sort by relevance)
+ final Sort docSort = getRandomSort();
+
+ for(SortField sf : docSort.getSort()) {
+ if (sf.getType() == SortField.SCORE) {
+ getScores = true;
+ }
+ }
+
+ for(SortField sf : groupSort.getSort()) {
+ if (sf.getType() == SortField.SCORE) {
+ getScores = true;
+ }
+ }
+
+ final int topNGroups = _TestUtil.nextInt(random, 1, 30);
+ //final int topNGroups = 10;
+ final int docsPerGroup = _TestUtil.nextInt(random, 1, 50);
+
+ final int groupOffset = _TestUtil.nextInt(random, 0, (topNGroups-1)/2);
+ //final int groupOffset = 0;
+
+ final int docOffset = _TestUtil.nextInt(random, 0, docsPerGroup-1);
+ //final int docOffset = 0;
+
+ final boolean doCache = random.nextBoolean();
+ final boolean doAllGroups = random.nextBoolean();
+ if (VERBOSE) {
+ System.out.println("TEST: groupSort=" + groupSort + " docSort=" + docSort + " searchTerm=" + searchTerm + " dF=" + r.docFreq(new Term("content", searchTerm)) +" dFBlock=" + rBlocks.docFreq(new Term("content", searchTerm)) + " topNGroups=" + topNGroups + " groupOffset=" + groupOffset + " docOffset=" + docOffset + " doCache=" + doCache + " docsPerGroup=" + docsPerGroup + " doAllGroups=" + doAllGroups + " getScores=" + getScores + " getMaxScores=" + getMaxScores);
+ }
+
+ final TermAllGroupsCollector allGroupsCollector;
+ if (doAllGroups) {
+ allGroupsCollector = new TermAllGroupsCollector("group");
+ } else {
+ allGroupsCollector = null;
+ }
+
+ final TermFirstPassGroupingCollector c1 = new TermFirstPassGroupingCollector("group", groupSort, groupOffset+topNGroups);
+ final CachingCollector cCache;
+ final Collector c;
+
+ final boolean useWrappingCollector = random.nextBoolean();
+
+ if (doCache) {
+ final double maxCacheMB = random.nextDouble();
+ if (VERBOSE) {
+ System.out.println("TEST: maxCacheMB=" + maxCacheMB);
+ }
+
+ if (useWrappingCollector) {
+ if (doAllGroups) {
+ cCache = CachingCollector.create(c1, true, maxCacheMB);
+ c = MultiCollector.wrap(cCache, allGroupsCollector);
+ } else {
+ c = cCache = CachingCollector.create(c1, true, maxCacheMB);
+ }
+ } else {
+ // Collect only into cache, then replay multiple times:
+ c = cCache = CachingCollector.create(false, true, maxCacheMB);
+ }
+ } else {
+ cCache = null;
+ if (doAllGroups) {
+ c = MultiCollector.wrap(c1, allGroupsCollector);
+ } else {
+ c = c1;
+ }
+ }
+
+ // Search top reader:
+ final Query query = new TermQuery(new Term("content", searchTerm));
+ s.search(query, c);
+
+ if (doCache && !useWrappingCollector) {
+ if (cCache.isCached()) {
+ // Replay for first-pass grouping
+ cCache.replay(c1);
+ if (doAllGroups) {
+ // Replay for all groups:
+ cCache.replay(allGroupsCollector);
+ }
+ } else {
+ // Replay by re-running search:
+ s.search(query, c1);
+ if (doAllGroups) {
+ s.search(query, allGroupsCollector);
+ }
+ }
+ }
+
+ // Get 1st pass top groups
+ final Collection<SearchGroup<String>> topGroups = c1.getTopGroups(groupOffset, fillFields);
+
+ if (VERBOSE) {
+ System.out.println("TEST: first pass topGroups");
+ if (topGroups == null) {
+ System.out.println(" null");
+ } else {
+ for(SearchGroup<String> searchGroup : topGroups) {
+ System.out.println(" " + (searchGroup.groupValue == null ? "null" : searchGroup.groupValue) + ": " + Arrays.deepToString(searchGroup.sortValues));
+ }
+ }
+ }
+
+ // Get 1st pass top groups using shards
+ final TopGroups<String> topGroupsShards = searchShards(s, shards, query, groupSort, docSort, groupOffset, topNGroups, docOffset, docsPerGroup, getScores, getMaxScores);
+
+ final TopGroups<String> groupsResult;
+ if (topGroups != null) {
+
+ if (VERBOSE) {
+ System.out.println("TEST: topGroups");
+ for (SearchGroup<String> searchGroup : topGroups) {
+ System.out.println(" " + (searchGroup.groupValue == null ? "null" : searchGroup.groupValue) + ": " + Arrays.deepToString(searchGroup.sortValues));
+ }
+ }
+
+ // Get 2nd pass grouped result:
+ final TermSecondPassGroupingCollector c2 = new TermSecondPassGroupingCollector("group", topGroups, groupSort, docSort, docOffset+docsPerGroup, getScores, getMaxScores, fillFields);
+ if (doCache) {
+ if (cCache.isCached()) {
+ if (VERBOSE) {
+ System.out.println("TEST: cache is intact");
+ }
+ cCache.replay(c2);
+ } else {
+ if (VERBOSE) {
+ System.out.println("TEST: cache was too large");
+ }
+ s.search(query, c2);
+ }
+ } else {
+ s.search(query, c2);
+ }
+
+ if (doAllGroups) {
+ TopGroups<String> tempTopGroups = c2.getTopGroups(docOffset);
+ groupsResult = new TopGroups<String>(tempTopGroups, allGroupsCollector.getGroupCount());
+ } else {
+ groupsResult = c2.getTopGroups(docOffset);
+ }
+ } else {
+ groupsResult = null;
+ if (VERBOSE) {
+ System.out.println("TEST: no results");
+ }
+ }
+
+ final TopGroups<String> expectedGroups = slowGrouping(groupDocs, searchTerm, fillFields, getScores, getMaxScores, doAllGroups, groupSort, docSort, topNGroups, docsPerGroup, groupOffset, docOffset);
+
+ if (VERBOSE) {
+ if (expectedGroups == null) {
+ System.out.println("TEST: no expected groups");
+ } else {
+ System.out.println("TEST: expected groups totalGroupedHitCount=" + expectedGroups.totalGroupedHitCount);
+ for(GroupDocs<String> gd : expectedGroups.groups) {
+ System.out.println(" group=" + (gd.groupValue == null ? "null" : gd.groupValue) + " totalHits=" + gd.totalHits);
+ for(ScoreDoc sd : gd.scoreDocs) {
+ System.out.println(" id=" + sd.doc + " score=" + sd.score);
+ }
+ }
+ }
+
+ if (groupsResult == null) {
+ System.out.println("TEST: no matched groups");
+ } else {
+ System.out.println("TEST: matched groups totalGroupedHitCount=" + groupsResult.totalGroupedHitCount);
+ for(GroupDocs<String> gd : groupsResult.groups) {
+ System.out.println(" group=" + (gd.groupValue == null ? "null" : gd.groupValue) + " totalHits=" + gd.totalHits);
+ for(ScoreDoc sd : gd.scoreDocs) {
+ System.out.println(" id=" + docIDToID[sd.doc] + " score=" + sd.score);
+ }
+ }
+
+ if (searchIter == 14) {
+ for(int docIDX=0;docIDX<s.maxDoc();docIDX++) {
+ System.out.println("ID=" + docIDToID[docIDX] + " explain=" + s.explain(query, docIDX));
+ }
+ }
+ }
+ }
+
+ assertEquals(docIDToID, expectedGroups, groupsResult, true, true, true, getScores);
+
+ // Confirm merged shards match:
+ assertEquals(docIDToID, expectedGroups, topGroupsShards, true, false, fillFields, getScores);
+ if (topGroupsShards != null) {
+ verifyShards(shards.docStarts, topGroupsShards);
+ }
+
+ final boolean needsScores = getScores || getMaxScores || docSort == null;
+ final BlockGroupingCollector c3 = new BlockGroupingCollector(groupSort, groupOffset+topNGroups, needsScores, lastDocInBlock);
+ final TermAllGroupsCollector allGroupsCollector2;
+ final Collector c4;
+ if (doAllGroups) {
+ allGroupsCollector2 = new TermAllGroupsCollector("group");
+ c4 = MultiCollector.wrap(c3, allGroupsCollector2);
+ } else {
+ allGroupsCollector2 = null;
+ c4 = c3;
+ }
+ // Get block grouping result:
+ sBlocks.search(query, c4);
+ @SuppressWarnings("unchecked")
+ final TopGroups<String> tempTopGroupsBlocks = c3.getTopGroups(docSort, groupOffset, docOffset, docOffset+docsPerGroup, fillFields);
+ final TopGroups<String> groupsResultBlocks;
+ if (doAllGroups && tempTopGroupsBlocks != null) {
+ assertEquals((int) tempTopGroupsBlocks.totalGroupCount, allGroupsCollector2.getGroupCount());
+ groupsResultBlocks = new TopGroups<String>(tempTopGroupsBlocks, allGroupsCollector2.getGroupCount());
+ } else {
+ groupsResultBlocks = tempTopGroupsBlocks;
+ }
+
+ // Get shard'd block grouping result:
+ final TopGroups<String> topGroupsBlockShards = searchShards(sBlocks, shardsBlocks, query, groupSort, docSort, groupOffset, topNGroups, docOffset, docsPerGroup, getScores, getMaxScores);
+
+ if (VERBOSE) {
+ if (groupsResultBlocks == null) {
+ System.out.println("TEST: no block groups");
+ } else {
+ System.out.println("TEST: block groups totalGroupedHitCount=" + groupsResultBlocks.totalGroupedHitCount);
+ boolean first = true;
+ for(GroupDocs<String> gd : groupsResultBlocks.groups) {
+ System.out.println(" group=" + gd.groupValue + " totalHits=" + gd.totalHits);
+ for(ScoreDoc sd : gd.scoreDocs) {
+ System.out.println(" id=" + docIDToIDBlocks[sd.doc] + " score=" + sd.score);
+ if (first) {
+ System.out.println("explain: " + sBlocks.explain(query, sd.doc));
+ first = false;
+ }
+ }
+ }
+ }
+ }
+
+ if (expectedGroups != null) {
+ // Fixup scores for reader2
+ for (GroupDocs groupDocsHits : expectedGroups.groups) {
+ for(ScoreDoc hit : groupDocsHits.scoreDocs) {
+ final GroupDoc gd = groupDocsByID[hit.doc];
+ assertEquals(gd.id, hit.doc);
+ //System.out.println("fixup score " + hit.score + " to " + gd.score2 + " vs " + gd.score);
+ hit.score = gd.score2;
+ }
+ }
+
+ final SortField[] sortFields = groupSort.getSort();
+ final Map<Float,Float> termScoreMap = scoreMap.get(searchTerm);
+ for(int groupSortIDX=0;groupSortIDX<sortFields.length;groupSortIDX++) {
+ if (sortFields[groupSortIDX].getType() == SortField.SCORE) {
+ for (GroupDocs groupDocsHits : expectedGroups.groups) {
+ if (groupDocsHits.groupSortValues != null) {
+ //System.out.println("remap " + groupDocsHits.groupSortValues[groupSortIDX] + " to " + termScoreMap.get(groupDocsHits.groupSortValues[groupSortIDX]));
+ groupDocsHits.groupSortValues[groupSortIDX] = termScoreMap.get(groupDocsHits.groupSortValues[groupSortIDX]);
+ assertNotNull(groupDocsHits.groupSortValues[groupSortIDX]);
+ }
+ }
+ }
+ }
+
+ final SortField[] docSortFields = docSort.getSort();
+ for(int docSortIDX=0;docSortIDX<docSortFields.length;docSortIDX++) {
+ if (docSortFields[docSortIDX].getType() == SortField.SCORE) {
+ for (GroupDocs groupDocsHits : expectedGroups.groups) {
+ for(ScoreDoc _hit : groupDocsHits.scoreDocs) {
+ FieldDoc hit = (FieldDoc) _hit;
+ if (hit.fields != null) {
+ hit.fields[docSortIDX] = termScoreMap.get(hit.fields[docSortIDX]);
+ assertNotNull(hit.fields[docSortIDX]);
+ }
+ }
+ }
+ }
+ }
+ }
+
+ assertEquals(docIDToIDBlocks, expectedGroups, groupsResultBlocks, false, true, true, getScores);
+ assertEquals(docIDToIDBlocks, expectedGroups, topGroupsBlockShards, false, false, fillFields, getScores);
+ }
+ s.close();
+ sBlocks.close();
+ } finally {
+ FieldCache.DEFAULT.purge(r);
+ if (rBlocks != null) {
+ FieldCache.DEFAULT.purge(rBlocks);
+ }
+ }
+
+ r.close();
+ dir.close();
+
+ rBlocks.close();
+ dirBlocks.close();
+ }
+ }
+
+ private void verifyShards(int[] docStarts, TopGroups<String> topGroups) {
+ for(GroupDocs group : topGroups.groups) {
+ for(int hitIDX=0;hitIDX<group.scoreDocs.length;hitIDX++) {
+ final ScoreDoc sd = group.scoreDocs[hitIDX];
+ assertEquals("doc=" + sd.doc + " wrong shard",
+ ReaderUtil.subIndex(sd.doc, docStarts),
+ sd.shardIndex);
+ }
+ }
+ }
+
+ private void assertEquals(Collection<SearchGroup<String>> groups1, Collection<SearchGroup<String>> groups2, boolean doSortValues) {
+ assertEquals(groups1.size(), groups2.size());
+ final Iterator<SearchGroup<String>> iter1 = groups1.iterator();
+ final Iterator<SearchGroup<String>> iter2 = groups2.iterator();
+
+ while(iter1.hasNext()) {
+ assertTrue(iter2.hasNext());
+
+ SearchGroup<String> group1 = iter1.next();
+ SearchGroup<String> group2 = iter2.next();
+
+ assertEquals(group1.groupValue, group2.groupValue);
+ if (doSortValues) {
+ assertArrayEquals(group1.sortValues, group2.sortValues);
+ }
+ }
+ assertFalse(iter2.hasNext());
+ }
+
+ private TopGroups<String> searchShards(IndexSearcher topSearcher, ShardState shardState, Query query, Sort groupSort, Sort docSort, int groupOffset, int topNGroups, int docOffset,
+ int topNDocs, boolean getScores, boolean getMaxScores) throws Exception {
+
+ // TODO: swap in caching, all groups collector here
+ // too...
+ if (VERBOSE) {
+ System.out.println("TEST: " + shardState.subSearchers.length + " shards: " + Arrays.toString(shardState.subSearchers));
+ }
+ // Run 1st pass collector to get top groups per shard
+ final Weight w = topSearcher.createNormalizedWeight(query);
+ final List<Collection<SearchGroup<String>>> shardGroups = new ArrayList<Collection<SearchGroup<String>>>();
+ for(int shardIDX=0;shardIDX<shardState.subSearchers.length;shardIDX++) {
+ final TermFirstPassGroupingCollector c = new TermFirstPassGroupingCollector("group", groupSort, groupOffset+topNGroups);
+ shardState.subSearchers[shardIDX].search(w, c);
+ final Collection<SearchGroup<String>> topGroups = c.getTopGroups(0, true);
+ if (topGroups != null) {
+ if (VERBOSE) {
+ System.out.println(" shard " + shardIDX + " s=" + shardState.subSearchers[shardIDX] + " " + topGroups.size() + " groups:");
+ for(SearchGroup<String> group : topGroups) {
+ System.out.println(" " + groupToString(group.groupValue) + " groupSort=" + Arrays.toString(group.sortValues));
+ }
+ }
+ shardGroups.add(topGroups);
+ }
+ }
+
+ final Collection<SearchGroup<String>> mergedTopGroups = SearchGroup.merge(shardGroups, groupOffset, topNGroups, groupSort);
+ if (VERBOSE) {
+ System.out.println(" merged:");
+ if (mergedTopGroups == null) {
+ System.out.println(" null");
+ } else {
+ for(SearchGroup<String> group : mergedTopGroups) {
+ System.out.println(" " + groupToString(group.groupValue) + " groupSort=" + Arrays.toString(group.sortValues));
+ }
+ }
+ }
+
+ if (mergedTopGroups != null) {
+
+ // Now 2nd pass:
+ @SuppressWarnings("unchecked")
+ final TopGroups<String>[] shardTopGroups = new TopGroups[shardState.subSearchers.length];
+ for(int shardIDX=0;shardIDX<shardState.subSearchers.length;shardIDX++) {
+ final TermSecondPassGroupingCollector c = new TermSecondPassGroupingCollector("group", mergedTopGroups, groupSort, docSort,
+ docOffset + topNDocs, getScores, getMaxScores, true);
+ shardState.subSearchers[shardIDX].search(w, c);
+ shardTopGroups[shardIDX] = c.getTopGroups(0);
+ rebaseDocIDs(groupSort, docSort, shardState.docStarts[shardIDX], shardTopGroups[shardIDX]);
+ }
+
+ return TopGroups.merge(shardTopGroups, groupSort, docSort, docOffset, topNDocs);
+ } else {
+ return null;
+ }
+ }
+
+ private List<Integer> getDocIDSortLocs(Sort sort) {
+ List<Integer> docFieldLocs = new ArrayList<Integer>();
+ SortField[] docFields = sort.getSort();
+ for(int fieldIDX=0;fieldIDX<docFields.length;fieldIDX++) {
+ if (docFields[fieldIDX].getType() == SortField.DOC) {
+ docFieldLocs.add(fieldIDX);
+ }
+ }
+
+ return docFieldLocs;
+ }
+
+ private void rebaseDocIDs(Sort groupSort, Sort docSort, int docBase, TopGroups<String> groups) {
+
+ List<Integer> docFieldLocs = getDocIDSortLocs(docSort);
+ List<Integer> docGroupFieldLocs = getDocIDSortLocs(groupSort);
+
+ for(GroupDocs<String> group : groups.groups) {
+ if (group.groupSortValues != null) {
+ for(int idx : docGroupFieldLocs) {
+ group.groupSortValues[idx] = Integer.valueOf(((Integer) group.groupSortValues[idx]).intValue() + docBase);
+ }
+ }
+
+ for(int hitIDX=0;hitIDX<group.scoreDocs.length;hitIDX++) {
+ final ScoreDoc sd = group.scoreDocs[hitIDX];
+ sd.doc += docBase;
+ if (sd instanceof FieldDoc) {
+ final FieldDoc fd = (FieldDoc) sd;
+ if (fd.fields != null) {
+ for(int idx : docFieldLocs) {
+ fd.fields[idx] = Integer.valueOf(((Integer) fd.fields[idx]).intValue() + docBase);
+ }
+ }
+ }
+ }
+ }
+ }
+
+ private void assertEquals(int[] docIDtoID, TopGroups expected, TopGroups actual, boolean verifyGroupValues, boolean verifyTotalGroupCount, boolean verifySortValues, boolean testScores) {
+ if (expected == null) {
+ assertNull(actual);
+ return;
+ }
+ assertNotNull(actual);
+
+ assertEquals(expected.groups.length, actual.groups.length);
+ assertEquals(expected.totalHitCount, actual.totalHitCount);
+ assertEquals(expected.totalGroupedHitCount, actual.totalGroupedHitCount);
+ if (expected.totalGroupCount != null && verifyTotalGroupCount) {
+ assertEquals(expected.totalGroupCount, actual.totalGroupCount);
+ }
+
+ for(int groupIDX=0;groupIDX<expected.groups.length;groupIDX++) {
+ if (VERBOSE) {
+ System.out.println(" check groupIDX=" + groupIDX);
+ }
+ final GroupDocs expectedGroup = expected.groups[groupIDX];
+ final GroupDocs actualGroup = actual.groups[groupIDX];
+ if (verifyGroupValues) {
+ assertEquals(expectedGroup.groupValue, actualGroup.groupValue);
+ }
+ if (verifySortValues) {
+ assertArrayEquals(expectedGroup.groupSortValues, actualGroup.groupSortValues);
+ }
+
+ // TODO
+ // assertEquals(expectedGroup.maxScore, actualGroup.maxScore);
+ assertEquals(expectedGroup.totalHits, actualGroup.totalHits);
+
+ final ScoreDoc[] expectedFDs = expectedGroup.scoreDocs;
+ final ScoreDoc[] actualFDs = actualGroup.scoreDocs;
+
+ assertEquals(expectedFDs.length, actualFDs.length);
+ for(int docIDX=0;docIDX<expectedFDs.length;docIDX++) {
+ final FieldDoc expectedFD = (FieldDoc) expectedFDs[docIDX];
+ final FieldDoc actualFD = (FieldDoc) actualFDs[docIDX];
+ //System.out.println(" actual doc=" + docIDtoID[actualFD.doc] + " score=" + actualFD.score);
+ assertEquals(expectedFD.doc, docIDtoID[actualFD.doc]);
+ if (testScores) {
+ assertEquals(expectedFD.score, actualFD.score, 0.1);
+ } else {
+ // TODO: too anal for now
+ //assertEquals(Float.NaN, actualFD.score);
+ }
+ if (verifySortValues) {
+ assertArrayEquals(expectedFD.fields, actualFD.fields);
+ }
+ }
+ }
+ }
+
+ private static class ShardSearcher {
+ private final IndexSearcher subSearcher;
+
+ public ShardSearcher(IndexReader subReader) {
+ this.subSearcher = new IndexSearcher(subReader);
+ }
+
+ public void search(Weight weight, Collector collector) throws IOException {
+ subSearcher.search(weight, null, collector);
+ }
+
+ public TopDocs search(Weight weight, int topN) throws IOException {
+ return subSearcher.search(weight, null, topN);
+ }
+
+ @Override
+ public String toString() {
+ return "ShardSearcher(" + subSearcher + ")";
+ }
+ }
+}
fnp / pylucene.git / blobdiff