src/Lucene.Net.Core/Index/ReaderManager.cs

namespace Lucene.Net.Index
{
    using Lucene.Net.Search;
    using Directory = Lucene.Net.Store.Directory;

    /*
         * 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 IndexSearcher = Lucene.Net.Search.IndexSearcher;

    /// <summary>
    /// Utility class to safely share <seealso cref="DirectoryReader"/> instances across
    /// multiple threads, while periodically reopening. this class ensures each
    /// reader is closed only once all threads have finished using it.
    /// </summary>
    /// <seealso cref= SearcherManager
    ///
    /// @lucene.experimental </seealso>
    public sealed class ReaderManager : ReferenceManager<DirectoryReader>
    {
        /// <summary>
        /// Creates and returns a new ReaderManager from the given
        /// <seealso cref="IndexWriter"/>.
        /// </summary>
        /// <param name="writer">
        ///          the IndexWriter to open the IndexReader from. </param>
        /// <param name="applyAllDeletes">
        ///          If <code>true</code>, all buffered deletes will be applied (made
        ///          visible) in the <seealso cref="IndexSearcher"/> / <seealso cref="DirectoryReader"/>.
        ///          If <code>false</code>, the deletes may or may not be applied, but
        ///          remain buffered (in IndexWriter) so that they will be applied in
        ///          the future. Applying deletes can be costly, so if your app can
        ///          tolerate deleted documents being returned you might gain some
        ///          performance by passing <code>false</code>. See
        ///          <seealso cref="DirectoryReader#openIfChanged(DirectoryReader, IndexWriter, boolean)"/>.
        /// </param>
        /// <exception cref="IOException"> If there is a low-level I/O error </exception>
        public ReaderManager(IndexWriter writer, bool applyAllDeletes)
        {
            Current = DirectoryReader.Open(writer, applyAllDeletes);
        }

        /// <summary>
        /// Creates and returns a new ReaderManager from the given <seealso cref="Directory"/>. </summary>
        /// <param name="dir"> the directory to open the DirectoryReader on.
        /// </param>
        /// <exception cref="IOException"> If there is a low-level I/O error </exception>
        public ReaderManager(Directory dir)
        {
            Current = DirectoryReader.Open(dir);
        }

        protected override void DecRef(DirectoryReader reference)
        {
            reference.DecRef();
        }

        protected override DirectoryReader RefreshIfNeeded(DirectoryReader referenceToRefresh)
        {
            return DirectoryReader.OpenIfChanged(referenceToRefresh);
        }

        protected override bool TryIncRef(DirectoryReader reference)
        {
            return reference.TryIncRef();
        }

        protected override int GetRefCount(DirectoryReader reference)
        {
            return reference.RefCount;
        }
    }
}