src/Lucene.Net.Tests/Search/Spans/TestNearSpansOrdered.cs

using Lucene.Net.Documents;
using Lucene.Net.Index;
using Lucene.Net.Index.Extensions;
using NUnit.Framework;
using Assert = Lucene.Net.TestFramework.Assert;

namespace Lucene.Net.Search.Spans
{
    /*
     * 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 AtomicReaderContext = Lucene.Net.Index.AtomicReaderContext;
    using Directory = Lucene.Net.Store.Directory;
    using Document = Documents.Document;
    using Field = Field;
    using IndexReader = Lucene.Net.Index.IndexReader;
    using IndexReaderContext = Lucene.Net.Index.IndexReaderContext;
    using LuceneTestCase = Lucene.Net.Util.LuceneTestCase;
    using MockAnalyzer = Lucene.Net.Analysis.MockAnalyzer;
    using RandomIndexWriter = Lucene.Net.Index.RandomIndexWriter;
    using Term = Lucene.Net.Index.Term;

    [TestFixture]
    public class TestNearSpansOrdered : LuceneTestCase
    {
        protected internal IndexSearcher searcher;
        protected internal Directory directory;
        protected internal IndexReader reader;

        public const string FIELD = "field";

        [TearDown]
        public override void TearDown()
        {
            reader.Dispose();
            directory.Dispose();
            base.TearDown();
        }

        [SetUp]
        public override void SetUp()
        {
            base.SetUp();
            directory = NewDirectory();
            RandomIndexWriter writer = new RandomIndexWriter(Random, directory, NewIndexWriterConfig(TEST_VERSION_CURRENT, new MockAnalyzer(Random)).SetMergePolicy(NewLogMergePolicy()));
            for (int i = 0; i < docFields.Length; i++)
            {
                Document doc = new Document();
                doc.Add(NewTextField(FIELD, docFields[i], Field.Store.NO));
                writer.AddDocument(doc);
            }
            reader = writer.GetReader();
            writer.Dispose();
            searcher = NewSearcher(reader);
        }

        protected internal string[] docFields = new string[] { "w1 w2 w3 w4 w5", "w1 w3 w2 w3 zz", "w1 xx w2 yy w3", "w1 w3 xx w2 yy w3 zz" };

        protected internal virtual SpanNearQuery MakeQuery(string s1, string s2, string s3, int slop, bool inOrder)
        {
            return new SpanNearQuery(new SpanQuery[] { new SpanTermQuery(new Term(FIELD, s1)), new SpanTermQuery(new Term(FIELD, s2)), new SpanTermQuery(new Term(FIELD, s3)) }, slop, inOrder);
        }

        protected internal virtual SpanNearQuery MakeQuery()
        {
            return MakeQuery("w1", "w2", "w3", 1, true);
        }

        [Test]
        public virtual void TestSpanNearQuery()
        {
            SpanNearQuery q = MakeQuery();
            CheckHits.DoCheckHits(
#if FEATURE_INSTANCE_TESTDATA_INITIALIZATION
                this,
#endif
                Random, q, FIELD, searcher, new int[] { 0, 1 });
        }

        public virtual string s(Spans span)
        {
            return s(span.Doc, span.Start, span.End);
        }

        public virtual string s(int doc, int start, int end)
        {
            return "s(" + doc + "," + start + "," + end + ")";
        }

        [Test]
        public virtual void TestNearSpansNext()
        {
            SpanNearQuery q = MakeQuery();
            Spans span = MultiSpansWrapper.Wrap(searcher.TopReaderContext, q);
            Assert.AreEqual(true, span.MoveNext());
            Assert.AreEqual(s(0, 0, 3), s(span));
            Assert.AreEqual(true, span.MoveNext());
            Assert.AreEqual(s(1, 0, 4), s(span));
            Assert.AreEqual(false, span.MoveNext());
        }

        /// <summary>
        /// test does not imply that skipTo(doc+1) should work exactly the
        /// same as next -- it's only applicable in this case since we know doc
        /// does not contain more than one span
        /// </summary>
        [Test]
        public virtual void TestNearSpansSkipToLikeNext()
        {
            SpanNearQuery q = MakeQuery();
            Spans span = MultiSpansWrapper.Wrap(searcher.TopReaderContext, q);
            Assert.AreEqual(true, span.SkipTo(0));
            Assert.AreEqual(s(0, 0, 3), s(span));
            Assert.AreEqual(true, span.SkipTo(1));
            Assert.AreEqual(s(1, 0, 4), s(span));
            Assert.AreEqual(false, span.SkipTo(2));
        }

        [Test]
        public virtual void TestNearSpansNextThenSkipTo()
        {
            SpanNearQuery q = MakeQuery();
            Spans span = MultiSpansWrapper.Wrap(searcher.TopReaderContext, q);
            Assert.AreEqual(true, span.MoveNext());
            Assert.AreEqual(s(0, 0, 3), s(span));
            Assert.AreEqual(true, span.SkipTo(1));
            Assert.AreEqual(s(1, 0, 4), s(span));
            Assert.AreEqual(false, span.MoveNext());
        }

        [Test]
        public virtual void TestNearSpansNextThenSkipPast()
        {
            SpanNearQuery q = MakeQuery();
            Spans span = MultiSpansWrapper.Wrap(searcher.TopReaderContext, q);
            Assert.AreEqual(true, span.MoveNext());
            Assert.AreEqual(s(0, 0, 3), s(span));
            Assert.AreEqual(false, span.SkipTo(2));
        }

        [Test]
        public virtual void TestNearSpansSkipPast()
        {
            SpanNearQuery q = MakeQuery();
            Spans span = MultiSpansWrapper.Wrap(searcher.TopReaderContext, q);
            Assert.AreEqual(false, span.SkipTo(2));
        }

        [Test]
        public virtual void TestNearSpansSkipTo0()
        {
            SpanNearQuery q = MakeQuery();
            Spans span = MultiSpansWrapper.Wrap(searcher.TopReaderContext, q);
            Assert.AreEqual(true, span.SkipTo(0));
            Assert.AreEqual(s(0, 0, 3), s(span));
        }

        [Test]
        public virtual void TestNearSpansSkipTo1()
        {
            SpanNearQuery q = MakeQuery();
            Spans span = MultiSpansWrapper.Wrap(searcher.TopReaderContext, q);
            Assert.AreEqual(true, span.SkipTo(1));
            Assert.AreEqual(s(1, 0, 4), s(span));
        }

        /// <summary>
        /// not a direct test of NearSpans, but a demonstration of how/when
        /// this causes problems
        /// </summary>
        [Test]
        public virtual void TestSpanNearScorerSkipTo1()
        {
            SpanNearQuery q = MakeQuery();
            Weight w = searcher.CreateNormalizedWeight(q);
            IndexReaderContext topReaderContext = searcher.TopReaderContext;
            AtomicReaderContext leave = topReaderContext.Leaves[0];
            Scorer s = w.GetScorer(leave, ((AtomicReader)leave.Reader).LiveDocs);
            Assert.AreEqual(1, s.Advance(1));
        }

        /// <summary>
        /// not a direct test of NearSpans, but a demonstration of how/when
        /// this causes problems
        /// </summary>
        [Test]
        public virtual void TestSpanNearScorerExplain()
        {
            SpanNearQuery q = MakeQuery();
            Explanation e = searcher.Explain(q, 1);
            Assert.IsTrue(0.0f < e.Value, "Scorer explanation value for doc#1 isn't positive: " + e.ToString());
        }
    }
}