lucene-java-3.5.0/lucene/src/java/org/apache/lucene/index/InvertedDocConsumer.java

   1 package org.apache.lucene.index;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import java.util.Collection;
  21 import java.util.Map;
  22 import java.io.IOException;
  23
  24 abstract class InvertedDocConsumer {
  25
  26   /** Add a new thread */
  27   abstract InvertedDocConsumerPerThread addThread(DocInverterPerThread docInverterPerThread);
  28
  29   /** Abort (called after hitting AbortException) */
  30   abstract void abort();
  31
  32   /** Flush a new segment */
  33   abstract void flush(Map<InvertedDocConsumerPerThread,Collection<InvertedDocConsumerPerField>> threadsAndFields, SegmentWriteState state) throws IOException;
  34
  35   /** Attempt to free RAM, returning true if any RAM was
  36    *  freed */
  37   abstract boolean freeRAM();
  38
  39   FieldInfos fieldInfos;
  40
  41   void setFieldInfos(FieldInfos fieldInfos) {
  42     this.fieldInfos = fieldInfos;
  43   }
  44 }