package org.apache.blur.lucene.search;
/**
* 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.
*/
import static junit.framework.Assert.assertEquals;
import static org.apache.blur.lucene.LuceneVersionConstant.LUCENE_VERSION;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import org.apache.blur.thrift.generated.ScoreType;
import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field.Store;
import org.apache.lucene.document.StringField;
import org.apache.lucene.index.CorruptIndexException;
import org.apache.lucene.index.DirectoryReader;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.IndexWriter;
import org.apache.lucene.index.IndexWriterConfig;
import org.apache.lucene.index.IndexableField;
import org.apache.lucene.index.Term;
import org.apache.lucene.search.BooleanClause.Occur;
import org.apache.lucene.search.BooleanQuery;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.TermQuery;
import org.apache.lucene.search.TopDocs;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.LockObtainFailedException;
import org.apache.lucene.store.RAMDirectory;
import org.junit.Test;
public class SuperQueryTest {
private static final String PERSON_NAME = "person.name";
private static final String ADDRESS_STREET = "address.street";
private static final String PRIME_DOC = "_p_";
private static final String PRIME_DOC_VALUE = "_true_";
private static final String NAME1 = "jon";
private static final String NAME2 = "jane";
private static final String STREET2 = "main st";
private static final String STREET1 = "main";
private static final String ROW_ID = "rowid";
@Test
public void testSimpleSuperQuery() throws CorruptIndexException, IOException, InterruptedException {
BooleanQuery booleanQuery = new BooleanQuery();
booleanQuery.add(wrapSuper(new TermQuery(new Term(PERSON_NAME, NAME1))), Occur.MUST);
booleanQuery.add(wrapSuper(new TermQuery(new Term(ADDRESS_STREET, STREET1))), Occur.MUST);
Directory directory = createIndex();
IndexReader reader = DirectoryReader.open(directory);
IndexSearcher searcher = new IndexSearcher(reader);
TopDocs topDocs = searcher.search(booleanQuery, 10);
assertEquals(2, topDocs.totalHits);
assertEquals("1", searcher.doc(topDocs.scoreDocs[0].doc).get(ROW_ID));
assertEquals("3", searcher.doc(topDocs.scoreDocs[1].doc).get(ROW_ID));
}
@Test
public void testAggregateScoreTypes() throws Exception {
IndexSearcher searcher = createSearcher();
BooleanQuery booleanQuery = new BooleanQuery();
booleanQuery.add(wrapSuper(PERSON_NAME, NAME1, ScoreType.AGGREGATE), Occur.SHOULD);
booleanQuery.add(wrapSuper(ADDRESS_STREET, STREET1, ScoreType.AGGREGATE), Occur.MUST);
TopDocs topDocs = searcher.search(booleanQuery, 10);
printTopDocs(topDocs);
assertEquals(3, topDocs.totalHits);
}
@Test
public void testBestScoreTypes() throws Exception {
IndexSearcher searcher = createSearcher();
BooleanQuery booleanQuery = new BooleanQuery();
booleanQuery.add(wrapSuper(PERSON_NAME, NAME1, ScoreType.BEST), Occur.SHOULD);
booleanQuery.add(wrapSuper(ADDRESS_STREET, STREET1, ScoreType.BEST), Occur.MUST);
TopDocs topDocs = searcher.search(booleanQuery, 10);
assertEquals(3, topDocs.totalHits);
printTopDocs(topDocs);
}
private void printTopDocs(TopDocs topDocs) {
for (int i = 0; i < topDocs.totalHits; i++) {
System.out.println("doc " + i + " score " + topDocs.scoreDocs[i].score);
}
}
@Test
public void testConstantScoreTypes() throws Exception {
IndexSearcher searcher = createSearcher();
BooleanQuery booleanQuery = new BooleanQuery();
booleanQuery.add(wrapSuper(PERSON_NAME, NAME1, ScoreType.CONSTANT), Occur.SHOULD);
booleanQuery.add(wrapSuper(ADDRESS_STREET, STREET1, ScoreType.CONSTANT), Occur.MUST);
TopDocs topDocs = searcher.search(booleanQuery, 10);
assertEquals(3, topDocs.totalHits);
printTopDocs(topDocs);
}
@Test
public void testSuperScoreTypes() throws Exception {
IndexSearcher searcher = createSearcher();
BooleanQuery booleanQuery = new BooleanQuery();
booleanQuery.add(wrapSuper(PERSON_NAME, NAME1, ScoreType.SUPER), Occur.SHOULD);
booleanQuery.add(wrapSuper(ADDRESS_STREET, STREET1, ScoreType.SUPER), Occur.MUST);
TopDocs topDocs = searcher.search(booleanQuery, 10);
assertEquals(3, topDocs.totalHits);
printTopDocs(topDocs);
}
@Test
public void testSuperScoreTypesWithFacet() throws Exception {
IndexSearcher searcher = createSearcher();
BooleanQuery booleanQuery = new BooleanQuery();
booleanQuery.add(wrapSuper(PERSON_NAME, NAME1, ScoreType.SUPER), Occur.SHOULD);
booleanQuery.add(wrapSuper(ADDRESS_STREET, STREET1, ScoreType.SUPER), Occur.MUST);
BooleanQuery f1 = new BooleanQuery();
f1.add(new TermQuery(new Term(PERSON_NAME, NAME1)), Occur.MUST);
f1.add(new TermQuery(new Term(PERSON_NAME, NAME2)), Occur.MUST);
Query[] facets = new Query[] { new SuperQuery(f1, ScoreType.CONSTANT, new Term(PRIME_DOC, PRIME_DOC_VALUE)) };
FacetExecutor executor = new FacetExecutor(facets.length);
FacetQuery query = new FacetQuery(booleanQuery, facets, executor);
executor.processFacets(null);
TopDocs topDocs = searcher.search(query, 10);
assertEquals(3, topDocs.totalHits);
printTopDocs(topDocs);
}
private static IndexSearcher createSearcher() throws Exception {
Directory directory = createIndex();
IndexReader reader = DirectoryReader.open(directory);
return new IndexSearcher(reader);
}
public static Directory createIndex() throws CorruptIndexException, LockObtainFailedException, IOException {
Directory directory = new RAMDirectory();
IndexWriter writer = new IndexWriter(directory, new IndexWriterConfig(LUCENE_VERSION, new StandardAnalyzer(LUCENE_VERSION)));
writer.addDocuments(addPrime(Arrays.asList(newDocument(newStringField(ROW_ID, "1"), newStringField(PERSON_NAME, NAME1)),
newDocument(newStringField(ROW_ID, "1"), newStringField(PERSON_NAME, NAME1)), newDocument(newStringField(ROW_ID, "1"), newStringField(ADDRESS_STREET, STREET1)))));
writer.addDocuments(addPrime(Arrays.asList(newDocument(newStringField(ROW_ID, "2"), newStringField(PERSON_NAME, NAME2)),
newDocument(newStringField(ROW_ID, "2"), newStringField(ADDRESS_STREET, STREET1)))));
writer.addDocuments(addPrime(Arrays.asList(newDocument(newStringField(ROW_ID, "3"), newStringField(PERSON_NAME, NAME1)),
newDocument(newStringField(ROW_ID, "3"), newStringField(ADDRESS_STREET, STREET1)), newDocument(newStringField(ROW_ID, "3"), newStringField(ADDRESS_STREET, STREET2)))));
writer.close();
return directory;
}
private static List<Document> addPrime(List<Document> docs) {
Document document = docs.get(0);
document.add(new StringField(PRIME_DOC, PRIME_DOC_VALUE, Store.NO));
return docs;
}
private static Document newDocument(IndexableField... fields) {
Document document = new Document();
for (IndexableField field : fields) {
document.add(field);
}
return document;
}
private static IndexableField newStringField(String name, String value) {
return new StringField(name, value, Store.YES);
}
private Query wrapSuper(Query query) {
return new SuperQuery(query, ScoreType.AGGREGATE, new Term(PRIME_DOC, PRIME_DOC_VALUE));
}
private Query wrapSuper(String field, String value, ScoreType scoreType) {
return new SuperQuery(new TermQuery(new Term(field, value)), scoreType, new Term(PRIME_DOC, PRIME_DOC_VALUE));
}
}