test/core/Index/TestLazyProxSkipping.cs

/* 
 * 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 WhitespaceAnalyzer = Lucene.Net.Analysis.WhitespaceAnalyzer;
using Document = Lucene.Net.Documents.Document;
using Field = Lucene.Net.Documents.Field;
using Directory = Lucene.Net.Store.Directory;
using IndexInput = Lucene.Net.Store.IndexInput;
using RAMDirectory = Lucene.Net.Store.RAMDirectory;
using IndexSearcher = Lucene.Net.Search.IndexSearcher;
using PhraseQuery = Lucene.Net.Search.PhraseQuery;
using ScoreDoc = Lucene.Net.Search.ScoreDoc;
using Searcher = Lucene.Net.Search.Searcher;
using LuceneTestCase = Lucene.Net.Util.LuceneTestCase;

namespace Lucene.Net.Index
{
	
	/// <summary> Tests lazy skipping on the proximity file.
	/// 
	/// </summary>
    [TestFixture]
	public class TestLazyProxSkipping:LuceneTestCase
	{
		private Searcher searcher;
		private int seeksCounter = 0;
		
		private System.String field = "tokens";
		private System.String term1 = "xx";
		private System.String term2 = "yy";
		private System.String term3 = "zz";
		
		[Serializable]
		private class SeekCountingDirectory:RAMDirectory
		{
			public SeekCountingDirectory(TestLazyProxSkipping enclosingInstance)
			{
				InitBlock(enclosingInstance);
			}
			private void  InitBlock(TestLazyProxSkipping enclosingInstance)
			{
				this.enclosingInstance = enclosingInstance;
			}
			private TestLazyProxSkipping enclosingInstance;
			public TestLazyProxSkipping Enclosing_Instance
			{
				get
				{
					return enclosingInstance;
				}
				
			}
			public override IndexInput OpenInput(System.String name)
			{
				IndexInput ii = base.OpenInput(name);
				if (name.EndsWith(".prx"))
				{
					// we decorate the proxStream with a wrapper class that allows to count the number of calls of seek()
					ii = new SeeksCountingStream(enclosingInstance, ii);
				}
				return ii;
			}
		}
		
		private void  CreateIndex(int numHits)
		{
			int numDocs = 500;
			
			Directory directory = new SeekCountingDirectory(this);
			IndexWriter writer = new IndexWriter(directory, new WhitespaceAnalyzer(), true, IndexWriter.MaxFieldLength.LIMITED);
			writer.UseCompoundFile = false;
			writer.SetMaxBufferedDocs(10);
			for (int i = 0; i < numDocs; i++)
			{
				Document doc = new Document();
				System.String content;
				if (i % (numDocs / numHits) == 0)
				{
					// add a document that matches the query "term1 term2"
					content = this.term1 + " " + this.term2;
				}
				else if (i % 15 == 0)
				{
					// add a document that only contains term1
					content = this.term1 + " " + this.term1;
				}
				else
				{
					// add a document that contains term2 but not term 1
					content = this.term3 + " " + this.term2;
				}
				
				doc.Add(new Field(this.field, content, Field.Store.YES, Field.Index.ANALYZED));
				writer.AddDocument(doc);
			}
			
			// make sure the index has only a single segment
			writer.Optimize();
			writer.Close();
			
			SegmentReader reader = SegmentReader.GetOnlySegmentReader(directory);
			
			this.searcher = new IndexSearcher(reader);
		}
		
		private ScoreDoc[] Search()
		{
			// create PhraseQuery "term1 term2" and search
			PhraseQuery pq = new PhraseQuery();
			pq.Add(new Term(this.field, this.term1));
			pq.Add(new Term(this.field, this.term2));
			return this.searcher.Search(pq, null, 1000).ScoreDocs;
		}
		
		private void  PerformTest(int numHits)
		{
			CreateIndex(numHits);
			this.seeksCounter = 0;
			ScoreDoc[] hits = Search();
			// verify that the right number of docs was found
			Assert.AreEqual(numHits, hits.Length);
			
			// check if the number of calls of seek() does not exceed the number of hits
			Assert.IsTrue(this.seeksCounter > 0);
			Assert.IsTrue(this.seeksCounter <= numHits + 1);
		}
		
		[Test]
		public virtual void  TestLazySkipping()
		{
			// test whether only the minimum amount of seeks() are performed
			PerformTest(5);
			PerformTest(10);
		}
		
		[Test]
		public virtual void  TestSeek()
		{
			Directory directory = new RAMDirectory();
			IndexWriter writer = new IndexWriter(directory, new WhitespaceAnalyzer(), true, IndexWriter.MaxFieldLength.LIMITED);
			for (int i = 0; i < 10; i++)
			{
				Document doc = new Document();
				doc.Add(new Field(this.field, "a b", Field.Store.YES, Field.Index.ANALYZED));
				writer.AddDocument(doc);
			}
			
			writer.Close();
		    IndexReader reader = IndexReader.Open(directory, true);
			TermPositions tp = reader.TermPositions();
			tp.Seek(new Term(this.field, "b"));
			for (int i = 0; i < 10; i++)
			{
				tp.Next();
				Assert.AreEqual(tp.Doc, i);
				Assert.AreEqual(tp.NextPosition(), 1);
			}
			tp.Seek(new Term(this.field, "a"));
			for (int i = 0; i < 10; i++)
			{
				tp.Next();
				Assert.AreEqual(tp.Doc, i);
				Assert.AreEqual(tp.NextPosition(), 0);
			}
		}
		
		
		// Simply extends IndexInput in a way that we are able to count the number
		// of invocations of seek()
		internal class SeeksCountingStream:IndexInput, System.ICloneable
		{
			private void  InitBlock(TestLazyProxSkipping enclosingInstance)
			{
				this.enclosingInstance = enclosingInstance;
			}
			private TestLazyProxSkipping enclosingInstance;
			public TestLazyProxSkipping Enclosing_Instance
			{
				get
				{
					return enclosingInstance;
				}
				
			}
			private IndexInput input;
		    private bool isDisposed;
			
			
			internal SeeksCountingStream(TestLazyProxSkipping enclosingInstance, IndexInput input)
			{
				InitBlock(enclosingInstance);
				this.input = input;
			}
			
			public override byte ReadByte()
			{
				return this.input.ReadByte();
			}
			
			public override void  ReadBytes(byte[] b, int offset, int len)
			{
				this.input.ReadBytes(b, offset, len);
			}

            protected override void Dispose(bool disposing)
            {
                if (isDisposed) return;

                if (disposing)
                {
                    this.input.Close();
                }
                isDisposed = true;
            }

		    public override long FilePointer
		    {
		        get { return this.input.FilePointer; }
		    }

		    public override void  Seek(long pos)
			{
				Enclosing_Instance.seeksCounter++;
				this.input.Seek(pos);
			}
			
			public override long Length()
			{
				return this.input.Length();
			}
			
			public override System.Object Clone()
			{
				return new SeeksCountingStream(enclosingInstance, (IndexInput) this.input.Clone());
			}
		}
	}
}