/*
* Copyright 2004 The Apache Software Foundation
*
* Licensed 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.
*/
using System;
using SimpleAnalyzer = Lucene.Net.Analysis.SimpleAnalyzer;
using Document = Lucene.Net.Documents.Document;
using Field = Lucene.Net.Documents.Field;
using Lucene.Net.Index;
using RAMDirectory = Lucene.Net.Store.RAMDirectory;
using NUnit.Framework;
namespace Lucene.Net.Search
{
/// Unit tests for sorting code.
///
///
Created: Feb 17, 2004 4:55:10 PM
///
///
/// Tim Jones (Nacimiento Software)
///
/// lucene 1.4
///
/// $Id: TestSort.java,v 1.7 2004/05/24 22:51:42 tjones Exp $
///
[Serializable] [TestFixture]
public class TestSort
{
private Searcher FullIndex
{
get
{
return GetIndex(true, true);
}
}
private Searcher XIndex
{
get
{
return GetIndex(true, false);
}
}
private Searcher YIndex
{
get
{
return GetIndex(false, true);
}
}
private Searcher EmptyIndex
{
get
{
return GetIndex(false, false);
}
}
private Lucene.Net.Search.Searchable Remote
{
get
{
try
{
return LookupRemote();
}
catch (System.Exception e)
{
StartServer();
return LookupRemote();
}
}
}
private Searcher full;
private Searcher searchX;
private Searcher searchY;
private Query queryX;
private Query queryY;
private Query queryA;
private Query queryF;
private Sort sort;
// document data:
// the tracer Field is used to determine which document was hit
// the contents Field is used to search and sort by relevance
// the int Field to sort by int
// the float Field to sort by float
// the string Field to sort by string
private System.String[][] data = new System.String[][]{new System.String[]{"A", "x a", "5", "4f", "c", "A-3"}, new System.String[]{"B", "y a", "5", "3.4028235E38", "i", "B-10"}, new System.String[]{"C", "x a b c", "2147483647", "1.0", "j", "A-2"}, new System.String[]{"D", "y a b c", "-1", "0.0f", "a", "C-0"}, new System.String[]{"E", "x a b c d", "5", "2f", "h", "B-8"}, new System.String[]{"F", "y a b c d", "2", "3.14159f", "g", "B-1"}, new System.String[]{"G", "x a b c d", "3", "-1.0", "f", "C-100"}, new System.String[]{"H", "y a b c d", "0", "1.4E-45", "e", "C-88"}, new System.String[]{"I", "x a b c d e f", "-2147483648", "1.0e+0", "d", "A-10"}, new System.String[]{"J", "y a b c d e f", "4", ".5", "b", "C-7"}, new System.String[]{"Z", "f", null, null, null, null}};
// create an index of all the documents, or just the x, or just the y documents
private Searcher GetIndex(bool even, bool odd)
{
RAMDirectory indexStore = new RAMDirectory();
IndexWriter writer = new IndexWriter(indexStore, new SimpleAnalyzer(), true);
for (int i = 0; i < data.Length; ++i)
{
if (((i % 2) == 0 && even) || ((i % 2) == 1 && odd))
{
Document doc = new Document(); // store, index, token
doc.Add(new Field("tracer", data[i][0], true, false, false));
doc.Add(new Field("contents", data[i][1], false, true, true));
if (data[i][2] != null)
doc.Add(new Field("int", data[i][2], false, true, false));
if (data[i][3] != null)
doc.Add(new Field("float", data[i][3], false, true, false));
if (data[i][4] != null)
doc.Add(new Field("string", data[i][4], false, true, false));
if (data[i][5] != null)
doc.Add(new Field("custom", data[i][5], false, true, false));
writer.AddDocument(doc);
}
}
writer.Optimize();
writer.Close();
return new IndexSearcher(indexStore);
}
[TestFixtureSetUp]
public virtual void SetUp()
{
full = FullIndex;
searchX = XIndex;
searchY = YIndex;
queryX = new TermQuery(new Term("contents", "x"));
queryY = new TermQuery(new Term("contents", "y"));
queryA = new TermQuery(new Term("contents", "a"));
queryF = new TermQuery(new Term("contents", "f"));
sort = new Sort();
}
// test the sorts by score and document number
[Test]
public virtual void TestBuiltInSorts()
{
sort = new Sort();
AssertMatches(full, queryX, sort, "ACEGI");
AssertMatches(full, queryY, sort, "BDFHJ");
sort.SetSort(SortField.FIELD_DOC);
AssertMatches(full, queryX, sort, "ACEGI");
AssertMatches(full, queryY, sort, "BDFHJ");
}
// test sorts where the type of Field is specified
[Test]
public virtual void TestTypedSort()
{
sort.SetSort(new SortField[]{new SortField("int", SortField.INT), SortField.FIELD_DOC});
AssertMatches(full, queryX, sort, "IGAEC");
AssertMatches(full, queryY, sort, "DHFJB");
sort.SetSort(new SortField[]{new SortField("float", SortField.FLOAT), SortField.FIELD_DOC});
AssertMatches(full, queryX, sort, "GCIEA");
AssertMatches(full, queryY, sort, "DHJFB");
sort.SetSort(new SortField[]{new SortField("string", SortField.STRING), SortField.FIELD_DOC});
AssertMatches(full, queryX, sort, "AIGEC");
AssertMatches(full, queryY, sort, "DJHFB");
}
// test sorts when there's nothing in the index
[Test]
public virtual void TestEmptyIndex()
{
Searcher empty = EmptyIndex;
sort = new Sort();
AssertMatches(empty, queryX, sort, "");
sort.SetSort(SortField.FIELD_DOC);
AssertMatches(empty, queryX, sort, "");
sort.SetSort(new SortField[]{new SortField("int", SortField.INT), SortField.FIELD_DOC});
AssertMatches(empty, queryX, sort, "");
sort.SetSort(new SortField[]{new SortField("string", SortField.STRING, true), SortField.FIELD_DOC});
AssertMatches(empty, queryX, sort, "");
sort.SetSort(new SortField[]{new SortField("float", SortField.FLOAT), new SortField("string", SortField.STRING)});
AssertMatches(empty, queryX, sort, "");
}
// test sorts where the type of Field is determined dynamically
[Test]
public virtual void TestAutoSort()
{
sort.SetSort("int");
AssertMatches(full, queryX, sort, "IGAEC");
AssertMatches(full, queryY, sort, "DHFJB");
sort.SetSort("float");
AssertMatches(full, queryX, sort, "GCIEA");
AssertMatches(full, queryY, sort, "DHJFB");
sort.SetSort("string");
AssertMatches(full, queryX, sort, "AIGEC");
AssertMatches(full, queryY, sort, "DJHFB");
}
// test sorts in reverse
[Test]
public virtual void TestReverseSort()
{
sort.SetSort(new SortField[]{new SortField(null, SortField.SCORE, true), SortField.FIELD_DOC});
AssertMatches(full, queryX, sort, "IEGCA");
AssertMatches(full, queryY, sort, "JFHDB");
sort.SetSort(new SortField(null, SortField.DOC, true));
AssertMatches(full, queryX, sort, "IGECA");
AssertMatches(full, queryY, sort, "JHFDB");
sort.SetSort("int", true);
AssertMatches(full, queryX, sort, "CAEGI");
AssertMatches(full, queryY, sort, "BJFHD");
sort.SetSort("float", true);
AssertMatches(full, queryX, sort, "AECIG");
AssertMatches(full, queryY, sort, "BFJHD");
sort.SetSort("string", true);
AssertMatches(full, queryX, sort, "CEGIA");
AssertMatches(full, queryY, sort, "BFHJD");
}
// test sorting when the sort Field is empty (undefined) for some of the documents
[Test]
public virtual void TestEmptyFieldSort()
{
sort.SetSort("string");
AssertMatches(full, queryF, sort, "ZJI");
sort.SetSort("string", true);
AssertMatches(full, queryF, sort, "IJZ");
sort.SetSort("int");
AssertMatches(full, queryF, sort, "IZJ");
sort.SetSort("int", true);
AssertMatches(full, queryF, sort, "JZI");
sort.SetSort("float");
AssertMatches(full, queryF, sort, "ZJI");
sort.SetSort("float", true);
AssertMatches(full, queryF, sort, "IJZ");
}
// test sorts using a series of fields
[Test]
public virtual void TestSortCombos()
{
sort.SetSort(new System.String[]{"int", "float"});
AssertMatches(full, queryX, sort, "IGEAC");
sort.SetSort(new SortField[]{new SortField("int", true), new SortField(null, SortField.DOC, true)});
AssertMatches(full, queryX, sort, "CEAGI");
sort.SetSort(new System.String[]{"float", "string"});
AssertMatches(full, queryX, sort, "GICEA");
}
// test using a Locale for sorting strings
[Test]
public virtual void TestLocaleSort()
{
sort.SetSort(new SortField[]{new SortField("string", new System.Globalization.CultureInfo("en-US"))});
AssertMatches(full, queryX, sort, "AIGEC");
AssertMatches(full, queryY, sort, "DJHFB");
sort.SetSort(new SortField[]{new SortField("string", new System.Globalization.CultureInfo("en-US"), true)});
AssertMatches(full, queryX, sort, "CEGIA");
AssertMatches(full, queryY, sort, "BFHJD");
}
// test a custom sort function
[Test]
public virtual void TestCustomSorts()
{
sort.SetSort(new SortField("custom", SampleComparable.ComparatorSource));
AssertMatches(full, queryX, sort, "CAIEG");
sort.SetSort(new SortField("custom", SampleComparable.ComparatorSource, true));
AssertMatches(full, queryY, sort, "HJDBF");
SortComparator custom = SampleComparable.Comparator;
sort.SetSort(new SortField("custom", custom));
AssertMatches(full, queryX, sort, "CAIEG");
sort.SetSort(new SortField("custom", custom, true));
AssertMatches(full, queryY, sort, "HJDBF");
}
// test a variety of sorts using more than one searcher
[Test]
public virtual void TestMultiSort()
{
MultiSearcher searcher = new MultiSearcher(new Lucene.Net.Search.Searchable[]{searchX, searchY});
RunMultiSorts(searcher);
}
// test a variety of sorts using a parallel multisearcher
[Test]
public virtual void TestParallelMultiSort()
{
Searcher searcher = new ParallelMultiSearcher(new Lucene.Net.Search.Searchable[]{searchX, searchY});
RunMultiSorts(searcher);
}
// test a variety of sorts using a remote searcher
[Test]
public virtual void TestRemoteSort()
{
Lucene.Net.Search.Searchable searcher = Remote;
MultiSearcher multi = new MultiSearcher(new Lucene.Net.Search.Searchable[]{searcher});
RunMultiSorts(multi);
}
// test custom search when remote
[Test]
public virtual void TestRemoteCustomSort()
{
Lucene.Net.Search.Searchable searcher = Remote;
MultiSearcher multi = new MultiSearcher(new Lucene.Net.Search.Searchable[]{searcher});
sort.SetSort(new SortField("custom", SampleComparable.ComparatorSource));
AssertMatches(multi, queryX, sort, "CAIEG");
sort.SetSort(new SortField("custom", SampleComparable.ComparatorSource, true));
AssertMatches(multi, queryY, sort, "HJDBF");
SortComparator custom = SampleComparable.Comparator;
sort.SetSort(new SortField("custom", custom));
AssertMatches(multi, queryX, sort, "CAIEG");
sort.SetSort(new SortField("custom", custom, true));
AssertMatches(multi, queryY, sort, "HJDBF");
}
// test that the relevancy scores are the same even if
// hits are sorted
[Test]
public virtual void TestNormalizedScores()
{
// capture relevancy scores
System.Collections.Hashtable scoresX = GetScores(full.Search(queryX));
System.Collections.Hashtable scoresY = GetScores(full.Search(queryY));
System.Collections.Hashtable scoresA = GetScores(full.Search(queryA));
// we'll test searching locally, remote and multi
// note: the multi test depends on each separate index containing
// the same documents as our local index, so the computed normalization
// will be the same. so we make a multi searcher over two equal document
// sets - not realistic, but necessary for testing.
MultiSearcher remote = new MultiSearcher(new Lucene.Net.Search.Searchable[]{Remote});
MultiSearcher multi = new MultiSearcher(new Lucene.Net.Search.Searchable[]{full, full});
// change sorting and make sure relevancy stays the same
sort = new Sort();
AssertSameValues(scoresX, GetScores(full.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(remote.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(multi.Search(queryX, sort)));
AssertSameValues(scoresY, GetScores(full.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(remote.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(multi.Search(queryY, sort)));
AssertSameValues(scoresA, GetScores(full.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(remote.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(multi.Search(queryA, sort)));
sort.SetSort(SortField.FIELD_DOC);
AssertSameValues(scoresX, GetScores(full.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(remote.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(multi.Search(queryX, sort)));
AssertSameValues(scoresY, GetScores(full.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(remote.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(multi.Search(queryY, sort)));
AssertSameValues(scoresA, GetScores(full.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(remote.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(multi.Search(queryA, sort)));
sort.SetSort("int");
AssertSameValues(scoresX, GetScores(full.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(remote.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(multi.Search(queryX, sort)));
AssertSameValues(scoresY, GetScores(full.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(remote.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(multi.Search(queryY, sort)));
AssertSameValues(scoresA, GetScores(full.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(remote.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(multi.Search(queryA, sort)));
sort.SetSort("float");
AssertSameValues(scoresX, GetScores(full.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(remote.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(multi.Search(queryX, sort)));
AssertSameValues(scoresY, GetScores(full.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(remote.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(multi.Search(queryY, sort)));
AssertSameValues(scoresA, GetScores(full.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(remote.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(multi.Search(queryA, sort)));
sort.SetSort("string");
AssertSameValues(scoresX, GetScores(full.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(remote.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(multi.Search(queryX, sort)));
AssertSameValues(scoresY, GetScores(full.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(remote.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(multi.Search(queryY, sort)));
AssertSameValues(scoresA, GetScores(full.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(remote.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(multi.Search(queryA, sort)));
sort.SetSort(new System.String[]{"int", "float"});
AssertSameValues(scoresX, GetScores(full.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(remote.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(multi.Search(queryX, sort)));
AssertSameValues(scoresY, GetScores(full.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(remote.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(multi.Search(queryY, sort)));
AssertSameValues(scoresA, GetScores(full.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(remote.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(multi.Search(queryA, sort)));
sort.SetSort(new SortField[]{new SortField("int", true), new SortField(null, SortField.DOC, true)});
AssertSameValues(scoresX, GetScores(full.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(remote.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(multi.Search(queryX, sort)));
AssertSameValues(scoresY, GetScores(full.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(remote.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(multi.Search(queryY, sort)));
AssertSameValues(scoresA, GetScores(full.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(remote.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(multi.Search(queryA, sort)));
sort.SetSort(new System.String[]{"float", "string"});
AssertSameValues(scoresX, GetScores(full.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(remote.Search(queryX, sort)));
AssertSameValues(scoresX, GetScores(multi.Search(queryX, sort)));
AssertSameValues(scoresY, GetScores(full.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(remote.Search(queryY, sort)));
AssertSameValues(scoresY, GetScores(multi.Search(queryY, sort)));
AssertSameValues(scoresA, GetScores(full.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(remote.Search(queryA, sort)));
AssertSameValues(scoresA, GetScores(multi.Search(queryA, sort)));
}
// runs a variety of sorts useful for multisearchers
private void RunMultiSorts(Searcher multi)
{
sort.SetSort(SortField.FIELD_DOC);
AssertMatchesPattern(multi, queryA, sort, "[AB]{2}[CD]{2}[EF]{2}[GH]{2}[IJ]{2}");
sort.SetSort(new SortField("int", SortField.INT));
AssertMatchesPattern(multi, queryA, sort, "IDHFGJ[ABE]{3}C");
sort.SetSort(new SortField[]{new SortField("int", SortField.INT), SortField.FIELD_DOC});
AssertMatchesPattern(multi, queryA, sort, "IDHFGJ[AB]{2}EC");
sort.SetSort("int");
AssertMatchesPattern(multi, queryA, sort, "IDHFGJ[AB]{2}EC");
sort.SetSort(new SortField[]{new SortField("float", SortField.FLOAT), SortField.FIELD_DOC});
AssertMatchesPattern(multi, queryA, sort, "GDHJ[CI]{2}EFAB");
sort.SetSort("float");
AssertMatchesPattern(multi, queryA, sort, "GDHJ[CI]{2}EFAB");
sort.SetSort("string");
AssertMatches(multi, queryA, sort, "DJAIHGFEBC");
sort.SetSort("int", true);
AssertMatchesPattern(multi, queryA, sort, "C[AB]{2}EJGFHDI");
sort.SetSort("float", true);
AssertMatchesPattern(multi, queryA, sort, "BAFE[IC]{2}JHDG");
sort.SetSort("string", true);
AssertMatches(multi, queryA, sort, "CBEFGHIAJD");
sort.SetSort(new SortField[]{new SortField("string", new System.Globalization.CultureInfo("en-US"))});
AssertMatches(multi, queryA, sort, "DJAIHGFEBC");
sort.SetSort(new SortField[]{new SortField("string", new System.Globalization.CultureInfo("en-US"), true)});
AssertMatches(multi, queryA, sort, "CBEFGHIAJD");
sort.SetSort(new System.String[]{"int", "float"});
AssertMatches(multi, queryA, sort, "IDHFGJEABC");
sort.SetSort(new System.String[]{"float", "string"});
AssertMatches(multi, queryA, sort, "GDHJICEFAB");
sort.SetSort("int");
AssertMatches(multi, queryF, sort, "IZJ");
sort.SetSort("int", true);
AssertMatches(multi, queryF, sort, "JZI");
sort.SetSort("float");
AssertMatches(multi, queryF, sort, "ZJI");
sort.SetSort("string");
AssertMatches(multi, queryF, sort, "ZJI");
sort.SetSort("string", true);
AssertMatches(multi, queryF, sort, "IJZ");
}
// make sure the documents returned by the search match the expected list
private void AssertMatches(Searcher searcher, Query query, Sort sort, System.String expectedResult)
{
Hits result = searcher.Search(query, sort);
System.Text.StringBuilder buff = new System.Text.StringBuilder(10);
int n = result.Length();
for (int i = 0; i < n; ++i)
{
Document doc = result.Doc(i);
System.String[] v = doc.GetValues("tracer");
for (int j = 0; j < v.Length; ++j)
{
buff.Append(v[j]);
}
}
Assert.AreEqual(expectedResult, buff.ToString());
}
// make sure the documents returned by the search match the expected list pattern
private void AssertMatchesPattern(Searcher searcher, Query query, Sort sort, System.String pattern)
{
Hits result = searcher.Search(query, sort);
System.Text.StringBuilder buff = new System.Text.StringBuilder(10);
int n = result.Length();
for (int i = 0; i < n; ++i)
{
Document doc = result.Doc(i);
System.String[] v = doc.GetValues("tracer");
for (int j = 0; j < v.Length; ++j)
{
buff.Append(v[j]);
}
}
// System.out.println ("matching \""+buff+"\" against pattern \""+pattern+"\"");
System.Text.RegularExpressions.Regex regex = new System.Text.RegularExpressions.Regex(pattern);
Assert.IsTrue(regex.IsMatch(buff.ToString()));
}
private System.Collections.Hashtable GetScores(Hits hits)
{
System.Collections.Hashtable scoreMap = new System.Collections.Hashtable();
int n = hits.Length();
for (int i = 0; i < n; ++i)
{
Document doc = hits.Doc(i);
System.String[] v = doc.GetValues("tracer");
Assert.AreEqual(v.Length, 1);
scoreMap[v[0]] = (float) hits.Score(i);
}
return scoreMap;
}
// make sure all the values in the maps match
private void AssertSameValues(System.Collections.Hashtable m1, System.Collections.Hashtable m2)
{
int n = m1.Count;
int m = m2.Count;
Assert.AreEqual(n, m);
System.Collections.IEnumerator iter = new System.Collections.Hashtable(m1).GetEnumerator();
while (iter.MoveNext())
{
System.Object key = iter.Current;
Assert.AreEqual(m1[key], m2[key]);
}
}
private Lucene.Net.Search.Searchable LookupRemote()
{
return (Lucene.Net.Search.Searchable) Activator.GetObject(typeof(Lucene.Net.Search.Searchable), "http://localhost/SortedSearchable");
}
private void StartServer()
{
// construct an index
Searcher local = FullIndex;
// local.search (queryA, new Sort());
// publish it
System.Runtime.Remoting.RemotingConfiguration reg = null; //// java.rmi.registry.LocateRegistry.CreateRegistry(1099); // {{Aroush}}
RemoteSearchable impl = new RemoteSearchable(local);
System.Runtime.Remoting.RemotingServices.Marshal(impl, ("http://localhost/SortedSearchable"));
}
}
}