From 65494af827c1034770bdd7082f6ed7c11370fd8e Mon Sep 17 00:00:00 2001 From: Michael McCandless Date: Tue, 14 Jul 2009 16:56:16 +0000 Subject: [PATCH] LUCENE-1272: add MoreLikeThis.set/getBoost git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@793973 13f79535-47bb-0310-9956-ffa450edef68 --- contrib/CHANGES.txt | 3 + .../lucene/search/similar/MoreLikeThis.java | 23 +++- .../search/similar/TestMoreLikeThis.java | 126 ++++++++++++++++++ 3 files changed, 151 insertions(+), 1 deletion(-) create mode 100644 contrib/queries/src/test/org/apache/lucene/search/similar/TestMoreLikeThis.java diff --git a/contrib/CHANGES.txt b/contrib/CHANGES.txt index 678a9e2c4ce..ff39273f4cb 100644 --- a/contrib/CHANGES.txt +++ b/contrib/CHANGES.txt @@ -72,6 +72,9 @@ New features 9. LUCENE-1740: Added "analyzer" command to Lucli, enabling changing the analyzer from the default StandardAnalyzer. (Bernd Fondermann via Mike McCandless) + +10. LUCENE-1272: Add get/setBoost to MoreLikeThis. (Jonathan + Leibiusky via Mike McCandless) Optimizations diff --git a/contrib/queries/src/java/org/apache/lucene/search/similar/MoreLikeThis.java b/contrib/queries/src/java/org/apache/lucene/search/similar/MoreLikeThis.java index fbc100cfbfc..6fed4b5be1f 100644 --- a/contrib/queries/src/java/org/apache/lucene/search/similar/MoreLikeThis.java +++ b/contrib/queries/src/java/org/apache/lucene/search/similar/MoreLikeThis.java @@ -281,6 +281,27 @@ public final class MoreLikeThis { */ private final IndexReader ir; + /** + * Boost factor to use when boosting the terms + */ + private float boostFactor = 1; + + /** + * Returns the boost factor used when boosting terms + * @return the boost factor used when boosting terms + */ + public float getBoostFactor() { + return boostFactor; + } + + /** + * Sets the boost factor to use when boosting terms + * @param boostFactor + */ + public void setBoostFactor(float boostFactor) { + this.boostFactor = boostFactor; + } + /** * Constructor requiring an IndexReader. */ @@ -586,7 +607,7 @@ public final class MoreLikeThis { } float myScore = ((Float) ar[2]).floatValue(); - tq.setBoost(myScore / bestScore); + tq.setBoost(boostFactor * myScore / bestScore); } try { diff --git a/contrib/queries/src/test/org/apache/lucene/search/similar/TestMoreLikeThis.java b/contrib/queries/src/test/org/apache/lucene/search/similar/TestMoreLikeThis.java new file mode 100644 index 00000000000..daf7cf10aa6 --- /dev/null +++ b/contrib/queries/src/test/org/apache/lucene/search/similar/TestMoreLikeThis.java @@ -0,0 +1,126 @@ +package org.apache.lucene.search.similar; + +/** + * 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 java.io.IOException; +import java.io.StringReader; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.apache.lucene.analysis.standard.StandardAnalyzer; +import org.apache.lucene.document.Document; +import org.apache.lucene.document.Field; +import org.apache.lucene.index.IndexReader; +import org.apache.lucene.index.IndexWriter; +import org.apache.lucene.index.IndexWriter.MaxFieldLength; +import org.apache.lucene.search.BooleanClause; +import org.apache.lucene.search.BooleanQuery; +import org.apache.lucene.search.IndexSearcher; +import org.apache.lucene.search.TermQuery; +import org.apache.lucene.store.RAMDirectory; +import org.apache.lucene.util.LuceneTestCase; + +public class TestMoreLikeThis extends LuceneTestCase { + private RAMDirectory directory; + private IndexReader reader; + private IndexSearcher searcher; + + protected void setUp() throws Exception { + directory = new RAMDirectory(); + IndexWriter writer = new IndexWriter(directory, new StandardAnalyzer(), + true, MaxFieldLength.UNLIMITED); + + // Add series of docs with specific information for MoreLikeThis + addDoc(writer, "lucene"); + addDoc(writer, "lucene release"); + + writer.close(); + reader = IndexReader.open(directory, true); + searcher = new IndexSearcher(reader); + + } + + protected void tearDown() throws Exception { + reader.close(); + searcher.close(); + directory.close(); + } + + private void addDoc(IndexWriter writer, String text) throws IOException { + Document doc = new Document(); + doc.add(new Field("text", text, Field.Store.YES, Field.Index.ANALYZED)); + writer.addDocument(doc); + } + + public void testBoostFactor() throws Throwable { + Map originalValues = getOriginalValues(); + + MoreLikeThis mlt = new MoreLikeThis( + reader); + mlt.setMinDocFreq(1); + mlt.setMinTermFreq(1); + mlt.setMinWordLen(1); + mlt.setFieldNames(new String[] { "text" }); + mlt.setBoost(true); + + // this mean that every term boost factor will be multiplied by this + // number + float boostFactor = 5; + mlt.setBoostFactor(boostFactor); + + BooleanQuery query = (BooleanQuery) mlt.like(new StringReader( + "lucene release")); + List clauses = query.clauses(); + + assertEquals("Expected " + originalValues.size() + " clauses.", + originalValues.size(), clauses.size()); + + for (int i = 0; i < clauses.size(); i++) { + BooleanClause clause = (BooleanClause) clauses.get(i); + TermQuery tq = (TermQuery) clause.getQuery(); + Float termBoost = (Float) originalValues.get(tq.getTerm().text()); + assertNotNull("Expected term " + tq.getTerm().text(), termBoost); + + float totalBoost = termBoost.floatValue() * boostFactor; + assertEquals("Expected boost of " + totalBoost + " for term '" + + tq.getTerm().text() + "' got " + tq.getBoost(), + totalBoost, tq.getBoost(), 0.0001); + } + } + + private Map getOriginalValues() throws IOException { + Map originalValues = new HashMap(); + MoreLikeThis mlt = new MoreLikeThis(reader); + mlt.setMinDocFreq(1); + mlt.setMinTermFreq(1); + mlt.setMinWordLen(1); + mlt.setFieldNames(new String[] { "text" }); + mlt.setBoost(true); + BooleanQuery query = (BooleanQuery) mlt.like(new StringReader( + "lucene release")); + List clauses = query.clauses(); + + for (int i = 0; i < clauses.size(); i++) { + BooleanClause clause = (BooleanClause) clauses.get(i); + TermQuery tq = (TermQuery) clause.getQuery(); + originalValues.put(tq.getTerm().text(), new Float(tq.getBoost())); + } + return originalValues; + } +}