DocFieldConsumer.cs

Go to the documentation of this file.

/* 
 * 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 System.Collections.Generic;

namespace Lucene.Net.Index
{
    
    abstract class DocFieldConsumer
    {
        
        internal FieldInfos fieldInfos;
        
        /// <summary>Called when DocumentsWriter decides to create a new
        /// segment 
        /// </summary>
        public abstract void Flush(IDictionary<DocFieldConsumerPerThread, ICollection<DocFieldConsumerPerField>> threadsAndFields, SegmentWriteState state);
        
        /// <summary>Called when DocumentsWriter decides to close the doc
        /// stores 
        /// </summary>
        public abstract void  CloseDocStore(SegmentWriteState state);
        
        /// <summary>Called when an aborting exception is hit </summary>
        public abstract void  Abort();
        
        /// <summary>Add a new thread </summary>
        public abstract DocFieldConsumerPerThread AddThread(DocFieldProcessorPerThread docFieldProcessorPerThread);
        
        /// <summary>Called when DocumentsWriter is using too much RAM.
        /// The consumer should free RAM, if possible, returning
        /// true if any RAM was in fact freed. 
        /// </summary>
        public abstract bool FreeRAM();
        
        internal virtual void  SetFieldInfos(FieldInfos fieldInfos)
        {
            this.fieldInfos = fieldInfos;
        }
    }
}