/*
* 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.queryparser.flexible.standard;
import java.io.Reader;
import java.io.StringReader;
import java.util.HashMap;
import java.util.Map;
import org.apache.lucene.analysis.*;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
import org.apache.lucene.index.DirectoryReader;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.IndexWriter;
import org.apache.lucene.queryparser.flexible.core.QueryNodeException;
import org.apache.lucene.queryparser.flexible.standard.config.StandardQueryConfigHandler;
import org.apache.lucene.search.BooleanClause.Occur;
import org.apache.lucene.search.BooleanClause;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.MatchNoDocsQuery;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.store.Directory;
import org.apache.lucene.util.IOUtils;
import org.apache.lucene.util.LuceneTestCase;
/**
* This test case is a copy of the core Lucene query parser test, it was adapted
* to use new QueryParserHelper instead of the old query parser.
*
* Tests QueryParser.
*/
public class TestMultiFieldQPHelper extends LuceneTestCase {
/**
* test stop words parsing for both the non static form, and for the
* corresponding static form (qtxt, fields[]).
*/
public void testStopwordsParsing() throws Exception {
assertStopQueryEquals("one", "b:one t:one");
assertStopQueryEquals("one stop", "b:one t:one");
assertStopQueryEquals("one (stop)", "b:one t:one");
assertStopQueryEquals("one ((stop))", "b:one t:one");
assertStopQueryIsMatchNoDocsQuery("stop");
assertStopQueryIsMatchNoDocsQuery("(stop)");
assertStopQueryIsMatchNoDocsQuery("((stop))");
}
// verify parsing of query using a stopping analyzer
private void assertStopQueryIsMatchNoDocsQuery(String qtxt) throws Exception {
String[] fields = { "b", "t" };
Occur occur[] = { Occur.SHOULD, Occur.SHOULD };
TestQPHelper.QPTestAnalyzer a = new TestQPHelper.QPTestAnalyzer();
StandardQueryParser mfqp = new StandardQueryParser();
mfqp.setMultiFields(fields);
mfqp.setAnalyzer(a);
Query q = mfqp.parse(qtxt, null);
assertTrue(q instanceof MatchNoDocsQuery);
}
// verify parsing of query using a stopping analyzer
private void assertStopQueryEquals(String qtxt, String expectedRes)
throws Exception {
String[] fields = { "b", "t" };
Occur occur[] = { Occur.SHOULD, Occur.SHOULD };
TestQPHelper.QPTestAnalyzer a = new TestQPHelper.QPTestAnalyzer();
StandardQueryParser mfqp = new StandardQueryParser();
mfqp.setMultiFields(fields);
mfqp.setAnalyzer(a);
Query q = mfqp.parse(qtxt, null);
assertEquals(expectedRes, q.toString().trim());
q = QueryParserUtil.parse(qtxt, fields, occur, a);
assertEquals(expectedRes, q.toString().trim());
}
public void testSimple() throws Exception {
String[] fields = { "b", "t" };
StandardQueryParser mfqp = new StandardQueryParser();
mfqp.setMultiFields(fields);
mfqp.setAnalyzer(new MockAnalyzer(random()));
Query q = mfqp.parse("one", null);
assertEquals("b:one t:one", q.toString());
q = mfqp.parse("one two", null);
assertEquals("(b:one t:one) (b:two t:two)", q.toString());
q = mfqp.parse("+one +two", null);
assertEquals("+(b:one t:one) +(b:two t:two)", q.toString());
q = mfqp.parse("+one -two -three", null);
assertEquals("+(b:one t:one) -(b:two t:two) -(b:three t:three)", q
.toString());
q = mfqp.parse("one^2 two", null);
assertEquals("(b:one t:one)^2.0 (b:two t:two)", q.toString());
q = mfqp.parse("one~ two", null);
assertEquals("(b:one~2 t:one~2) (b:two t:two)", q.toString());
q = mfqp.parse("one~0.8 two^2", null);
assertEquals("(b:one~0 t:one~0) (b:two t:two)^2.0", q.toString());
q = mfqp.parse("one* two*", null);
assertEquals("(b:one* t:one*) (b:two* t:two*)", q.toString());
q = mfqp.parse("[a TO c] two", null);
assertEquals("(b:[a TO c] t:[a TO c]) (b:two t:two)", q.toString());
q = mfqp.parse("w?ldcard", null);
assertEquals("b:w?ldcard t:w?ldcard", q.toString());
q = mfqp.parse("\"foo bar\"", null);
assertEquals("b:\"foo bar\" t:\"foo bar\"", q.toString());
q = mfqp.parse("\"aa bb cc\" \"dd ee\"", null);
assertEquals("(b:\"aa bb cc\" t:\"aa bb cc\") (b:\"dd ee\" t:\"dd ee\")", q
.toString());
q = mfqp.parse("\"foo bar\"~4", null);
assertEquals("b:\"foo bar\"~4 t:\"foo bar\"~4", q.toString());
// LUCENE-1213: QueryParser was ignoring slop when phrase
// had a field.
q = mfqp.parse("b:\"foo bar\"~4", null);
assertEquals("b:\"foo bar\"~4", q.toString());
// make sure that terms which have a field are not touched:
q = mfqp.parse("one f:two", null);
assertEquals("(b:one t:one) f:two", q.toString());
// AND mode:
mfqp.setDefaultOperator(StandardQueryConfigHandler.Operator.AND);
q = mfqp.parse("one two", null);
assertEquals("+(b:one t:one) +(b:two t:two)", q.toString());
q = mfqp.parse("\"aa bb cc\" \"dd ee\"", null);
assertEquals("+(b:\"aa bb cc\" t:\"aa bb cc\") +(b:\"dd ee\" t:\"dd ee\")",
q.toString());
}
public void testBoostsSimple() throws Exception {
Map<String,Float> boosts = new HashMap<>();
boosts.put("b", Float.valueOf(5));
boosts.put("t", Float.valueOf(10));
String[] fields = { "b", "t" };
StandardQueryParser mfqp = new StandardQueryParser();
mfqp.setMultiFields(fields);
mfqp.setFieldsBoost(boosts);
mfqp.setAnalyzer(new MockAnalyzer(random()));
// Check for simple
Query q = mfqp.parse("one", null);
assertEquals("(b:one)^5.0 (t:one)^10.0", q.toString());
// Check for AND
q = mfqp.parse("one AND two", null);
assertEquals("+((b:one)^5.0 (t:one)^10.0) +((b:two)^5.0 (t:two)^10.0)", q
.toString());
// Check for OR
q = mfqp.parse("one OR two", null);
assertEquals("((b:one)^5.0 (t:one)^10.0) ((b:two)^5.0 (t:two)^10.0)", q.toString());
// Check for AND and a field
q = mfqp.parse("one AND two AND foo:test", null);
assertEquals("+((b:one)^5.0 (t:one)^10.0) +((b:two)^5.0 (t:two)^10.0) +foo:test", q
.toString());
q = mfqp.parse("one^3 AND two^4", null);
assertEquals("+((b:one)^5.0 (t:one)^10.0)^3.0 +((b:two)^5.0 (t:two)^10.0)^4.0",
q.toString());
}
public void testStaticMethod1() throws QueryNodeException {
String[] fields = { "b", "t" };
String[] queries = { "one", "two" };
Query q = QueryParserUtil.parse(queries, fields, new MockAnalyzer(random()));
assertEquals("b:one t:two", q.toString());
String[] queries2 = { "+one", "+two" };
q = QueryParserUtil.parse(queries2, fields, new MockAnalyzer(random()));
assertEquals("b:one t:two", q.toString());
String[] queries3 = { "one", "+two" };
q = QueryParserUtil.parse(queries3, fields, new MockAnalyzer(random()));
assertEquals("b:one t:two", q.toString());
String[] queries4 = { "one +more", "+two" };
q = QueryParserUtil.parse(queries4, fields, new MockAnalyzer(random()));
assertEquals("(b:one +b:more) t:two", q.toString());
String[] queries5 = { "blah" };
// expected exception, array length differs
expectThrows(IllegalArgumentException.class, () -> {
QueryParserUtil.parse(queries5, fields, new MockAnalyzer(random()));
});
// check also with stop words for this static form (qtxts[], fields[]).
TestQPHelper.QPTestAnalyzer stopA = new TestQPHelper.QPTestAnalyzer();
String[] queries6 = { "((+stop))", "+((stop))" };
q = QueryParserUtil.parse(queries6, fields, stopA);
assertEquals("MatchNoDocsQuery(\"\") MatchNoDocsQuery(\"\")", q.toString());
//assertEquals(" ", q.toString());
String[] queries7 = { "one ((+stop)) +more", "+((stop)) +two" };
q = QueryParserUtil.parse(queries7, fields, stopA);
assertEquals("(b:one +b:more) (+t:two)", q.toString());
}
public void testStaticMethod2() throws QueryNodeException {
String[] fields = { "b", "t" };
BooleanClause.Occur[] flags = { BooleanClause.Occur.MUST,
BooleanClause.Occur.MUST_NOT };
Query q = QueryParserUtil.parse("one", fields, flags,
new MockAnalyzer(random()));
assertEquals("+b:one -t:one", q.toString());
q = QueryParserUtil.parse("one two", fields, flags, new MockAnalyzer(random()));
assertEquals("+(b:one b:two) -(t:one t:two)", q.toString());
// expected exception, array length differs
expectThrows(IllegalArgumentException.class, () -> {
BooleanClause.Occur[] flags2 = { BooleanClause.Occur.MUST };
QueryParserUtil.parse("blah", fields, flags2, new MockAnalyzer(random()));
});
}
public void testStaticMethod2Old() throws QueryNodeException {
String[] fields = { "b", "t" };
BooleanClause.Occur[] flags = { BooleanClause.Occur.MUST,
BooleanClause.Occur.MUST_NOT };
StandardQueryParser parser = new StandardQueryParser();
parser.setMultiFields(fields);
parser.setAnalyzer(new MockAnalyzer(random()));
Query q = QueryParserUtil.parse("one", fields, flags,
new MockAnalyzer(random()));// , fields, flags, new
// MockAnalyzer());
assertEquals("+b:one -t:one", q.toString());
q = QueryParserUtil.parse("one two", fields, flags, new MockAnalyzer(random()));
assertEquals("+(b:one b:two) -(t:one t:two)", q.toString());
// expected exception, array length differs
expectThrows(IllegalArgumentException.class, () -> {
BooleanClause.Occur[] flags2 = { BooleanClause.Occur.MUST };
QueryParserUtil.parse("blah", fields, flags2, new MockAnalyzer(random()));
});
}
public void testStaticMethod3() throws QueryNodeException {
String[] queries = { "one", "two", "three" };
String[] fields = { "f1", "f2", "f3" };
BooleanClause.Occur[] flags = { BooleanClause.Occur.MUST,
BooleanClause.Occur.MUST_NOT, BooleanClause.Occur.SHOULD };
Query q = QueryParserUtil.parse(queries, fields, flags,
new MockAnalyzer(random()));
assertEquals("+f1:one -f2:two f3:three", q.toString());
// expected exception, array length differs
expectThrows(IllegalArgumentException.class, () -> {
BooleanClause.Occur[] flags2 = { BooleanClause.Occur.MUST };
QueryParserUtil
.parse(queries, fields, flags2, new MockAnalyzer(random()));
});
}
public void testStaticMethod3Old() throws QueryNodeException {
String[] queries = { "one", "two" };
String[] fields = { "b", "t" };
BooleanClause.Occur[] flags = { BooleanClause.Occur.MUST,
BooleanClause.Occur.MUST_NOT };
Query q = QueryParserUtil.parse(queries, fields, flags,
new MockAnalyzer(random()));
assertEquals("+b:one -t:two", q.toString());
// expected exception, array length differs
expectThrows(IllegalArgumentException.class, () -> {
BooleanClause.Occur[] flags2 = { BooleanClause.Occur.MUST };
QueryParserUtil
.parse(queries, fields, flags2, new MockAnalyzer(random()));
});
}
public void testAnalyzerReturningNull() throws QueryNodeException {
String[] fields = new String[] { "f1", "f2", "f3" };
StandardQueryParser parser = new StandardQueryParser();
parser.setMultiFields(fields);
parser.setAnalyzer(new AnalyzerReturningNull());
Query q = parser.parse("bla AND blo", null);
assertEquals("+(f2:bla f3:bla) +(f2:blo f3:blo)", q.toString());
// the following queries are not affected as their terms are not
// analyzed anyway:
q = parser.parse("bla*", null);
assertEquals("f1:bla* f2:bla* f3:bla*", q.toString());
q = parser.parse("bla~", null);
assertEquals("f1:bla~2 f2:bla~2 f3:bla~2", q.toString());
q = parser.parse("[a TO c]", null);
assertEquals("f1:[a TO c] f2:[a TO c] f3:[a TO c]", q.toString());
}
public void testStopWordSearching() throws Exception {
Analyzer analyzer = new MockAnalyzer(random());
Directory ramDir = newDirectory();
IndexWriter iw = new IndexWriter(ramDir, newIndexWriterConfig(analyzer));
Document doc = new Document();
doc.add(newTextField("body", "blah the footest blah", Field.Store.NO));
iw.addDocument(doc);
iw.close();
StandardQueryParser mfqp = new StandardQueryParser();
mfqp.setMultiFields(new String[] { "body" });
mfqp.setAnalyzer(analyzer);
mfqp.setDefaultOperator(StandardQueryConfigHandler.Operator.AND);
Query q = mfqp.parse("the footest", null);
IndexReader ir = DirectoryReader.open(ramDir);
IndexSearcher is = newSearcher(ir);
ScoreDoc[] hits = is.search(q, 1000).scoreDocs;
assertEquals(1, hits.length);
ir.close();
ramDir.close();
}
/**
* Return no tokens for field "f1".
*/
private static class AnalyzerReturningNull extends Analyzer {
MockAnalyzer stdAnalyzer = new MockAnalyzer(random());
public AnalyzerReturningNull() {
super(PER_FIELD_REUSE_STRATEGY);
}
@Override
protected Reader initReader(String fieldName, Reader reader) {
if ("f1".equals(fieldName)) {
// we don't use the reader, so close it:
IOUtils.closeWhileHandlingException(reader);
// return empty reader, so MockTokenizer returns no tokens:
return new StringReader("");
} else {
return super.initReader(fieldName, reader);
}
}
@Override
public TokenStreamComponents createComponents(String fieldName) {
return stdAnalyzer.createComponents(fieldName);
}
}
}