/*
* 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.solr.client.solrj.response;
import junit.framework.Assert;
import org.apache.solr.SolrJettyTestBase;
import org.apache.solr.client.solrj.SolrQuery;
import org.apache.solr.client.solrj.request.QueryRequest;
import org.apache.solr.client.solrj.response.SpellCheckResponse.Collation;
import org.apache.solr.client.solrj.response.SpellCheckResponse.Correction;
import org.apache.solr.common.SolrInputDocument;
import org.apache.solr.common.params.CommonParams;
import org.apache.solr.common.params.SpellingParams;
import org.junit.BeforeClass;
import org.junit.Test;
import java.util.List;
/**
* Test for SpellCheckComponent's response in Solrj
*
*
* @since solr 1.3
*/
public class TestSpellCheckResponse extends SolrJettyTestBase {
@BeforeClass
public static void beforeTest() throws Exception {
initCore();
}
static String field = "name";
@Test
public void testSpellCheckResponse() throws Exception {
getSolrClient();
client.deleteByQuery("*:*");
client.commit(true, true);
SolrInputDocument doc = new SolrInputDocument();
doc.setField("id", "111");
doc.setField(field, "Samsung");
client.add(doc);
client.commit(true, true);
SolrQuery query = new SolrQuery("*:*");
query.set(CommonParams.QT, "/spell");
query.set("spellcheck", true);
query.set(SpellingParams.SPELLCHECK_Q, "samsang");
QueryRequest request = new QueryRequest(query);
SpellCheckResponse response = request.process(client).getSpellCheckResponse();
Assert.assertEquals("samsung", response.getFirstSuggestion("samsang"));
}
@Test
public void testSpellCheckResponse_Extended() throws Exception {
getSolrClient();
client.deleteByQuery("*:*");
client.commit(true, true);
SolrInputDocument doc = new SolrInputDocument();
doc.setField("id", "111");
doc.setField(field, "Samsung");
client.add(doc);
client.commit(true, true);
SolrQuery query = new SolrQuery("*:*");
query.set(CommonParams.QT, "/spell");
query.set("spellcheck", true);
query.set(SpellingParams.SPELLCHECK_Q, "samsang");
query.set(SpellingParams.SPELLCHECK_EXTENDED_RESULTS, true);
QueryRequest request = new QueryRequest(query);
SpellCheckResponse response = request.process(client).getSpellCheckResponse();
assertEquals("samsung", response.getFirstSuggestion("samsang"));
SpellCheckResponse.Suggestion sug = response.getSuggestion("samsang");
List<SpellCheckResponse.Suggestion> sugs = response.getSuggestions();
assertEquals(sug.getAlternatives().size(), sug.getAlternativeFrequencies().size());
assertEquals(sugs.get(0).getAlternatives().size(), sugs.get(0).getAlternativeFrequencies().size());
assertEquals("samsung", sug.getAlternatives().get(0));
assertEquals("samsung", sugs.get(0).getAlternatives().get(0));
// basic test if fields were filled in
assertTrue(sug.getEndOffset()>0);
assertTrue(sug.getToken().length() > 0);
assertTrue(sug.getNumFound() > 0);
// assertTrue(sug.getOriginalFrequency() > 0);
// Hmmm... the API for SpellCheckResponse could be nicer:
response.getSuggestions().get(0).getAlternatives().get(0);
}
@Test
public void testSpellCheckCollationResponse() throws Exception {
getSolrClient();
client.deleteByQuery("*:*");
client.commit(true, true);
SolrInputDocument doc = new SolrInputDocument();
doc.setField("id", "0");
doc.setField("name", "faith hope and love");
client.add(doc);
doc = new SolrInputDocument();
doc.setField("id", "1");
doc.setField("name", "faith hope and loaves");
client.add(doc);
doc = new SolrInputDocument();
doc.setField("id", "2");
doc.setField("name", "fat hops and loaves");
client.add(doc);
doc = new SolrInputDocument();
doc.setField("id", "3");
doc.setField("name", "faith of homer");
client.add(doc);
doc = new SolrInputDocument();
doc.setField("id", "4");
doc.setField("name", "fat of homer");
client.add(doc);
client.commit(true, true);
//Test Backwards Compatibility
SolrQuery query = new SolrQuery("name:(+fauth +home +loane)");
query.set(CommonParams.QT, "/spell");
query.set("spellcheck", true);
query.set(SpellingParams.SPELLCHECK_COUNT, 10);
query.set(SpellingParams.SPELLCHECK_COLLATE, true);
QueryRequest request = new QueryRequest(query);
SpellCheckResponse response = request.process(client).getSpellCheckResponse();
response = request.process(client).getSpellCheckResponse();
assertTrue("name:(+faith +hope +loaves)".equals(response.getCollatedResult()));
//Test Expanded Collation Results
query.set(SpellingParams.SPELLCHECK_COLLATE_EXTENDED_RESULTS, true);
query.set(SpellingParams.SPELLCHECK_MAX_COLLATION_TRIES, 10);
query.set(SpellingParams.SPELLCHECK_MAX_COLLATIONS, 2);
request = new QueryRequest(query);
response = request.process(client).getSpellCheckResponse();
assertTrue("name:(+faith +hope +love)".equals(response.getCollatedResult()) || "name:(+faith +hope +loaves)".equals(response.getCollatedResult()));
List<Collation> collations = response.getCollatedResults();
assertEquals(2, collations.size());
for(Collation collation : collations)
{
assertTrue("name:(+faith +hope +love)".equals(collation.getCollationQueryString()) || "name:(+faith +hope +loaves)".equals(collation.getCollationQueryString()));
assertTrue(collation.getNumberOfHits()==1);
List<Correction> misspellingsAndCorrections = collation.getMisspellingsAndCorrections();
assertTrue(misspellingsAndCorrections.size()==3);
for(Correction correction : misspellingsAndCorrections)
{
if("fauth".equals(correction.getOriginal()))
{
assertTrue("faith".equals(correction.getCorrection()));
} else if("home".equals(correction.getOriginal()))
{
assertTrue("hope".equals(correction.getCorrection()));
} else if("loane".equals(correction.getOriginal()))
{
assertTrue("love".equals(correction.getCorrection()) || "loaves".equals(correction.getCorrection()));
} else
{
fail("Original Word Should have been either fauth, home or loane.");
}
}
}
query.set(SpellingParams.SPELLCHECK_COLLATE_EXTENDED_RESULTS, false);
response = request.process(client).getSpellCheckResponse();
{
collations = response.getCollatedResults();
assertEquals(2, collations.size());
String collation1 = collations.get(0).getCollationQueryString();
String collation2 = collations.get(1).getCollationQueryString();
assertFalse(collation1 + " equals " + collation2,
collation1.equals(collation2));
for(Collation collation : collations) {
assertTrue("name:(+faith +hope +love)".equals(collation.getCollationQueryString()) || "name:(+faith +hope +loaves)".equals(collation.getCollationQueryString()));
}
}
}
}