test/core/Search/TestCustomSearcherSort.cs - lucenenet - Git at Google

 /*
  * 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.
  */

 using System;

 using NUnit.Framework;

 using StandardAnalyzer = Lucene.Net.Analysis.Standard.StandardAnalyzer;
 using DateTools = Lucene.Net.Documents.DateTools;
 using Document = Lucene.Net.Documents.Document;
 using Field = Lucene.Net.Documents.Field;
 using IndexReader = Lucene.Net.Index.IndexReader;
 using IndexWriter = Lucene.Net.Index.IndexWriter;
 using Term = Lucene.Net.Index.Term;
 using Directory = Lucene.Net.Store.Directory;
 using RAMDirectory = Lucene.Net.Store.RAMDirectory;
 using LuceneTestCase = Lucene.Net.Util.LuceneTestCase;

 namespace Lucene.Net.Search
 {

 	/// <summary> Unit test for sorting code.
 	///
 	/// </summary>

 	[Serializable]
     [TestFixture]
 	public class TestCustomSearcherSort:LuceneTestCase
 	{

 		private Directory index = null;
 		private Query query = null;
 		// reduced from 20000 to 2000 to speed up test...
 		private const int INDEX_SIZE = 2000;

 		/*public TestCustomSearcherSort(System.String name):base(name)
 		{
 		}*/

 		/*[STAThread]
 		public static void  Main(System.String[] argv)
 		{
 			// TestRunner.run(suite()); // {{Aroush-2.9}} how is this done in NUnit?
 		}*/

 		/*public static Test suite()
 		{
 			return new TestSuite(typeof(TestCustomSearcherSort));
 		}*/


 		// create an index for testing
 		private Directory GetIndex()
 		{
 			RAMDirectory indexStore = new RAMDirectory();
 			IndexWriter writer = new IndexWriter(indexStore, new StandardAnalyzer(Util.Version.LUCENE_CURRENT), true, IndexWriter.MaxFieldLength.LIMITED);
 			RandomGen random = new RandomGen(this, NewRandom());
 			for (int i = 0; i < INDEX_SIZE; ++i)
 			{
 				// don't decrease; if to low the problem doesn't show up
 				Document doc = new Document();
 				if ((i % 5) != 0)
 				{
 					// some documents must not have an entry in the first sort field
 					doc.Add(new Field("publicationDate_", random.GetLuceneDate(), Field.Store.YES, Field.Index.NOT_ANALYZED));
 				}
 				if ((i % 7) == 0)
 				{
 					// some documents to match the query (see below)
 					doc.Add(new Field("content", "test", Field.Store.YES, Field.Index.ANALYZED));
 				}
 				// every document has a defined 'mandant' field
 				doc.Add(new Field("mandant", System.Convert.ToString(i % 3), Field.Store.YES, Field.Index.NOT_ANALYZED));
 				writer.AddDocument(doc);
 			}
 			writer.Optimize();
 			writer.Close();
 			return indexStore;
 		}

 		/// <summary> Create index and query for test cases. </summary>
 		[SetUp]
 		public override void  SetUp()
 		{
 			base.SetUp();
 			index = GetIndex();
 			query = new TermQuery(new Term("content", "test"));
 		}

 		/// <summary> Run the test using two CustomSearcher instances. </summary>
 		[Test]
 		public virtual void  TestFieldSortCustomSearcher()
 		{
 			// log("Run testFieldSortCustomSearcher");
 			// define the sort criteria
 			Sort custSort = new Sort(new SortField("publicationDate_", SortField.STRING), SortField.FIELD_SCORE);
 			Searcher searcher = new CustomSearcher(this, index, 2);
 			// search and check hits
 			MatchHits(searcher, custSort);
 		}
 		/// <summary> Run the test using one CustomSearcher wrapped by a MultiSearcher. </summary>
 		[Test]
 		public virtual void  TestFieldSortSingleSearcher()
 		{
 			// log("Run testFieldSortSingleSearcher");
 			// define the sort criteria
 			Sort custSort = new Sort(new SortField("publicationDate_", SortField.STRING), SortField.FIELD_SCORE);
 			Searcher searcher = new MultiSearcher(new Searcher[]{new CustomSearcher(this, index, 2)});
 			// search and check hits
 			MatchHits(searcher, custSort);
 		}
 		/// <summary> Run the test using two CustomSearcher instances. </summary>
 		[Test]
 		public virtual void  TestFieldSortMultiCustomSearcher()
 		{
 			// log("Run testFieldSortMultiCustomSearcher");
 			// define the sort criteria
             Sort custSort = new Sort(new SortField("publicationDate_", SortField.STRING), SortField.FIELD_SCORE);
 			Searcher searcher = new MultiSearcher(new Searchable[]{new CustomSearcher(this, index, 0), new CustomSearcher(this, index, 2)});
 			// search and check hits
 			MatchHits(searcher, custSort);
 		}


 		// make sure the documents returned by the search match the expected list
 		private void  MatchHits(Searcher searcher, Sort sort)
 		{
 			// make a query without sorting first
 			ScoreDoc[] hitsByRank = searcher.Search(query, null, 1000).ScoreDocs;
 			CheckHits(hitsByRank, "Sort by rank: "); // check for duplicates
 			System.Collections.IDictionary resultMap = new System.Collections.SortedList();
 			// store hits in TreeMap - TreeMap does not allow duplicates; existing entries are silently overwritten
 			for (int hitid = 0; hitid < hitsByRank.Length; ++hitid)
 			{
 				resultMap[hitsByRank[hitid].Doc] = hitid; // Value: Hits-Objekt Index
 			}

 			// now make a query using the sort criteria
 			ScoreDoc[] resultSort = searcher.Search(query, null, 1000, sort).ScoreDocs;
 			CheckHits(resultSort, "Sort by custom criteria: "); // check for duplicates

 			// besides the sorting both sets of hits must be identical
 			for (int hitid = 0; hitid < resultSort.Length; ++hitid)
 			{
 				System.Int32 idHitDate = (System.Int32) resultSort[hitid].Doc; // document ID from sorted search
 				if (!resultMap.Contains(idHitDate))
 				{
 					Log("ID " + idHitDate + " not found. Possibliy a duplicate.");
 				}
 				Assert.IsTrue(resultMap.Contains(idHitDate)); // same ID must be in the Map from the rank-sorted search
 				// every hit must appear once in both result sets --> remove it from the Map.
 				// At the end the Map must be empty!
 				resultMap.Remove(idHitDate);
 			}
 			if (resultMap.Count == 0)
 			{
 				// log("All hits matched");
 			}
 			else
 			{
 				Log("Couldn't match " + resultMap.Count + " hits.");
 			}
 			Assert.AreEqual(resultMap.Count, 0);
 		}

 		/// <summary> Check the hits for duplicates.</summary>
 		/// <param name="hits">
 		/// </param>
 		private void  CheckHits(ScoreDoc[] hits, System.String prefix)
 		{
 			if (hits != null)
 			{
 				System.Collections.IDictionary idMap = new System.Collections.SortedList();
 				for (int docnum = 0; docnum < hits.Length; ++docnum)
 				{
 					int luceneId;

 					luceneId = hits[docnum].Doc;
 					if (idMap.Contains(luceneId))
 					{
 						System.Text.StringBuilder message = new System.Text.StringBuilder(prefix);
 						message.Append("Duplicate key for hit index = ");
 						message.Append(docnum);
 						message.Append(", previous index = ");
 						message.Append(((System.Int32) idMap[luceneId]).ToString());
 						message.Append(", Lucene ID = ");
 						message.Append(luceneId);
 						Log(message.ToString());
 					}
 					else
 					{
 						idMap[luceneId] = docnum;
 					}
 				}
 			}
 		}

 		// Simply write to console - choosen to be independant of log4j etc
 		private void  Log(System.String message)
 		{
 			System.Console.Out.WriteLine(message);
 		}

 		public class CustomSearcher:IndexSearcher
 		{
 			private void  InitBlock(TestCustomSearcherSort enclosingInstance)
 			{
 				this.enclosingInstance = enclosingInstance;
 			}
 			private TestCustomSearcherSort enclosingInstance;
 			public TestCustomSearcherSort Enclosing_Instance
 			{
 				get
 				{
 					return enclosingInstance;
 				}

 			}
 			private int switcher;

 		    /// <param name="directory">
 		    /// </param>
 		    /// <throws>  IOException </throws>
 		    public CustomSearcher(TestCustomSearcherSort enclosingInstance, Directory directory, int switcher)
 		        : base(directory, true)
 			{
 				InitBlock(enclosingInstance);
 				this.switcher = switcher;
 			}
 			/// <param name="r">
 			/// </param>
 			public CustomSearcher(TestCustomSearcherSort enclosingInstance, IndexReader r, int switcher):base(r)
 			{
 				InitBlock(enclosingInstance);
 				this.switcher = switcher;
 			}
 			/* (non-Javadoc)
 			* @see Lucene.Net.Search.Searchable#search(Lucene.Net.Search.Query, Lucene.Net.Search.Filter, int, Lucene.Net.Search.Sort)
 			*/
 			public override TopFieldDocs Search(Query query, Filter filter, int nDocs, Sort sort)
 			{
 				BooleanQuery bq = new BooleanQuery();
 				bq.Add(query, Occur.MUST);
 				bq.Add(new TermQuery(new Term("mandant", System.Convert.ToString(switcher))), Occur.MUST);
 				return base.Search(bq, filter, nDocs, sort);
 			}
 			/* (non-Javadoc)
 			* @see Lucene.Net.Search.Searchable#search(Lucene.Net.Search.Query, Lucene.Net.Search.Filter, int)
 			*/
 			public override TopDocs Search(Query query, Filter filter, int nDocs)
 			{
 				BooleanQuery bq = new BooleanQuery();
 				bq.Add(query, Occur.MUST);
 				bq.Add(new TermQuery(new Term("mandant", System.Convert.ToString(switcher))), Occur.MUST);
 				return base.Search(bq, filter, nDocs);
 			}
 		}
 		private class RandomGen
 		{
 			private void  InitBlock(TestCustomSearcherSort enclosingInstance)
 			{
 				this.enclosingInstance = enclosingInstance;
 				System.DateTime temp_calendar;
 				temp_calendar = new System.DateTime(1980, 1, 1, 0, 0, 0, 0, new System.Globalization.GregorianCalendar());
 				base_Renamed = temp_calendar;
 			}
 			private TestCustomSearcherSort enclosingInstance;
 			public TestCustomSearcherSort Enclosing_Instance
 			{
 				get
 				{
 					return enclosingInstance;
 				}

 			}
 			internal RandomGen(TestCustomSearcherSort enclosingInstance, System.Random random)
 			{
 				InitBlock(enclosingInstance);
 				this.random = random;
 			}
 			private System.Random random;
 			private System.DateTime base_Renamed;

 			// Just to generate some different Lucene Date strings
 			public /*private*/ System.String GetLuceneDate()
 			{
                 return DateTools.TimeToString((base_Renamed.Ticks / TimeSpan.TicksPerMillisecond) + random.Next() - System.Int32.MinValue, DateTools.Resolution.DAY);
 			}
 		}
 	}
 }
	/*
	* 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.
	*/

	using System;

	using NUnit.Framework;

	using StandardAnalyzer = Lucene.Net.Analysis.Standard.StandardAnalyzer;
	using DateTools = Lucene.Net.Documents.DateTools;
	using Document = Lucene.Net.Documents.Document;
	using Field = Lucene.Net.Documents.Field;
	using IndexReader = Lucene.Net.Index.IndexReader;
	using IndexWriter = Lucene.Net.Index.IndexWriter;
	using Term = Lucene.Net.Index.Term;
	using Directory = Lucene.Net.Store.Directory;
	using RAMDirectory = Lucene.Net.Store.RAMDirectory;
	using LuceneTestCase = Lucene.Net.Util.LuceneTestCase;

	namespace Lucene.Net.Search
	{

	/// <summary> Unit test for sorting code.
	///
	/// </summary>

	[Serializable]
	[TestFixture]
	public class TestCustomSearcherSort:LuceneTestCase
	{

	private Directory index = null;
	private Query query = null;
	// reduced from 20000 to 2000 to speed up test...
	private const int INDEX_SIZE = 2000;

	/*public TestCustomSearcherSort(System.String name):base(name)
	{
	}*/

	/*[STAThread]
	public static void Main(System.String[] argv)
	{
	// TestRunner.run(suite()); // {{Aroush-2.9}} how is this done in NUnit?
	}*/

	/*public static Test suite()
	{
	return new TestSuite(typeof(TestCustomSearcherSort));
	}*/


	// create an index for testing
	private Directory GetIndex()
	{
	RAMDirectory indexStore = new RAMDirectory();
	IndexWriter writer = new IndexWriter(indexStore, new StandardAnalyzer(Util.Version.LUCENE_CURRENT), true, IndexWriter.MaxFieldLength.LIMITED);
	RandomGen random = new RandomGen(this, NewRandom());
	for (int i = 0; i < INDEX_SIZE; ++i)
	{
	// don't decrease; if to low the problem doesn't show up
	Document doc = new Document();
	if ((i % 5) != 0)
	{
	// some documents must not have an entry in the first sort field
	doc.Add(new Field("publicationDate_", random.GetLuceneDate(), Field.Store.YES, Field.Index.NOT_ANALYZED));
	}
	if ((i % 7) == 0)
	{
	// some documents to match the query (see below)
	doc.Add(new Field("content", "test", Field.Store.YES, Field.Index.ANALYZED));
	}
	// every document has a defined 'mandant' field
	doc.Add(new Field("mandant", System.Convert.ToString(i % 3), Field.Store.YES, Field.Index.NOT_ANALYZED));
	writer.AddDocument(doc);
	}
	writer.Optimize();
	writer.Close();
	return indexStore;
	}

	/// <summary> Create index and query for test cases. </summary>
	[SetUp]
	public override void SetUp()
	{
	base.SetUp();
	index = GetIndex();
	query = new TermQuery(new Term("content", "test"));
	}

	/// <summary> Run the test using two CustomSearcher instances. </summary>
	[Test]
	public virtual void TestFieldSortCustomSearcher()
	{
	// log("Run testFieldSortCustomSearcher");
	// define the sort criteria
	Sort custSort = new Sort(new SortField("publicationDate_", SortField.STRING), SortField.FIELD_SCORE);
	Searcher searcher = new CustomSearcher(this, index, 2);
	// search and check hits
	MatchHits(searcher, custSort);
	}
	/// <summary> Run the test using one CustomSearcher wrapped by a MultiSearcher. </summary>
	[Test]
	public virtual void TestFieldSortSingleSearcher()
	{
	// log("Run testFieldSortSingleSearcher");
	// define the sort criteria
	Sort custSort = new Sort(new SortField("publicationDate_", SortField.STRING), SortField.FIELD_SCORE);
	Searcher searcher = new MultiSearcher(new Searcher[]{new CustomSearcher(this, index, 2)});
	// search and check hits
	MatchHits(searcher, custSort);
	}
	/// <summary> Run the test using two CustomSearcher instances. </summary>
	[Test]
	public virtual void TestFieldSortMultiCustomSearcher()
	{
	// log("Run testFieldSortMultiCustomSearcher");
	// define the sort criteria
	Sort custSort = new Sort(new SortField("publicationDate_", SortField.STRING), SortField.FIELD_SCORE);
	Searcher searcher = new MultiSearcher(new Searchable[]{new CustomSearcher(this, index, 0), new CustomSearcher(this, index, 2)});
	// search and check hits
	MatchHits(searcher, custSort);
	}


	// make sure the documents returned by the search match the expected list
	private void MatchHits(Searcher searcher, Sort sort)
	{
	// make a query without sorting first
	ScoreDoc[] hitsByRank = searcher.Search(query, null, 1000).ScoreDocs;
	CheckHits(hitsByRank, "Sort by rank: "); // check for duplicates
	System.Collections.IDictionary resultMap = new System.Collections.SortedList();
	// store hits in TreeMap - TreeMap does not allow duplicates; existing entries are silently overwritten
	for (int hitid = 0; hitid < hitsByRank.Length; ++hitid)
	{
	resultMap[hitsByRank[hitid].Doc] = hitid; // Value: Hits-Objekt Index
	}

	// now make a query using the sort criteria
	ScoreDoc[] resultSort = searcher.Search(query, null, 1000, sort).ScoreDocs;
	CheckHits(resultSort, "Sort by custom criteria: "); // check for duplicates

	// besides the sorting both sets of hits must be identical
	for (int hitid = 0; hitid < resultSort.Length; ++hitid)
	{
	System.Int32 idHitDate = (System.Int32) resultSort[hitid].Doc; // document ID from sorted search
	if (!resultMap.Contains(idHitDate))
	{
	Log("ID " + idHitDate + " not found. Possibliy a duplicate.");
	}
	Assert.IsTrue(resultMap.Contains(idHitDate)); // same ID must be in the Map from the rank-sorted search
	// every hit must appear once in both result sets --> remove it from the Map.
	// At the end the Map must be empty!
	resultMap.Remove(idHitDate);
	}
	if (resultMap.Count == 0)
	{
	// log("All hits matched");
	}
	else
	{
	Log("Couldn't match " + resultMap.Count + " hits.");
	}
	Assert.AreEqual(resultMap.Count, 0);
	}

	/// <summary> Check the hits for duplicates.</summary>
	/// <param name="hits">
	/// </param>
	private void CheckHits(ScoreDoc[] hits, System.String prefix)
	{
	if (hits != null)
	{
	System.Collections.IDictionary idMap = new System.Collections.SortedList();
	for (int docnum = 0; docnum < hits.Length; ++docnum)
	{
	int luceneId;

	luceneId = hits[docnum].Doc;
	if (idMap.Contains(luceneId))
	{
	System.Text.StringBuilder message = new System.Text.StringBuilder(prefix);
	message.Append("Duplicate key for hit index = ");
	message.Append(docnum);
	message.Append(", previous index = ");
	message.Append(((System.Int32) idMap[luceneId]).ToString());
	message.Append(", Lucene ID = ");
	message.Append(luceneId);
	Log(message.ToString());
	}
	else
	{
	idMap[luceneId] = docnum;
	}
	}
	}
	}

	// Simply write to console - choosen to be independant of log4j etc
	private void Log(System.String message)
	{
	System.Console.Out.WriteLine(message);
	}

	public class CustomSearcher:IndexSearcher
	{
	private void InitBlock(TestCustomSearcherSort enclosingInstance)
	{
	this.enclosingInstance = enclosingInstance;
	}
	private TestCustomSearcherSort enclosingInstance;
	public TestCustomSearcherSort Enclosing_Instance
	{
	get
	{
	return enclosingInstance;
	}

	}
	private int switcher;

	/// <param name="directory">
	/// </param>
	/// <throws> IOException </throws>
	public CustomSearcher(TestCustomSearcherSort enclosingInstance, Directory directory, int switcher)
	: base(directory, true)
	{
	InitBlock(enclosingInstance);
	this.switcher = switcher;
	}
	/// <param name="r">
	/// </param>
	public CustomSearcher(TestCustomSearcherSort enclosingInstance, IndexReader r, int switcher):base(r)
	{
	InitBlock(enclosingInstance);
	this.switcher = switcher;
	}
	/* (non-Javadoc)
	* @see Lucene.Net.Search.Searchable#search(Lucene.Net.Search.Query, Lucene.Net.Search.Filter, int, Lucene.Net.Search.Sort)
	*/
	public override TopFieldDocs Search(Query query, Filter filter, int nDocs, Sort sort)
	{
	BooleanQuery bq = new BooleanQuery();
	bq.Add(query, Occur.MUST);
	bq.Add(new TermQuery(new Term("mandant", System.Convert.ToString(switcher))), Occur.MUST);
	return base.Search(bq, filter, nDocs, sort);
	}
	/* (non-Javadoc)
	* @see Lucene.Net.Search.Searchable#search(Lucene.Net.Search.Query, Lucene.Net.Search.Filter, int)
	*/
	public override TopDocs Search(Query query, Filter filter, int nDocs)
	{
	BooleanQuery bq = new BooleanQuery();
	bq.Add(query, Occur.MUST);
	bq.Add(new TermQuery(new Term("mandant", System.Convert.ToString(switcher))), Occur.MUST);
	return base.Search(bq, filter, nDocs);
	}
	}
	private class RandomGen
	{
	private void InitBlock(TestCustomSearcherSort enclosingInstance)
	{
	this.enclosingInstance = enclosingInstance;
	System.DateTime temp_calendar;
	temp_calendar = new System.DateTime(1980, 1, 1, 0, 0, 0, 0, new System.Globalization.GregorianCalendar());
	base_Renamed = temp_calendar;
	}
	private TestCustomSearcherSort enclosingInstance;
	public TestCustomSearcherSort Enclosing_Instance
	{
	get
	{
	return enclosingInstance;
	}

	}
	internal RandomGen(TestCustomSearcherSort enclosingInstance, System.Random random)
	{
	InitBlock(enclosingInstance);
	this.random = random;
	}
	private System.Random random;
	private System.DateTime base_Renamed;

	// Just to generate some different Lucene Date strings
	public /private/ System.String GetLuceneDate()
	{
	return DateTools.TimeToString((base_Renamed.Ticks / TimeSpan.TicksPerMillisecond) + random.Next() - System.Int32.MinValue, DateTools.Resolution.DAY);
	}
	}
	}
	}