Lucene example source code file (FormatPostingsFieldsConsumer.java)

This example Lucene source code file (FormatPostingsFieldsConsumer.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Lucene tags/keywords

formatpostingsfieldsconsumer, formatpostingsfieldsconsumer, formatpostingstermsconsumer, formatpostingstermsconsumer, io, ioexception, ioexception

The Lucene FormatPostingsFieldsConsumer.java source code

package org.apache.lucene.index;

/**
 * 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.
 */

import java.io.IOException;

/** Abstract API that consumes terms, doc, freq, prox and
 *  payloads postings.  Concrete implementations of this
 *  actually do "something" with the postings (write it into
 *  the index in a specific format).
 *
 * @lucene.experimental
 */
abstract class FormatPostingsFieldsConsumer {

  /** Add a new field */
  abstract FormatPostingsTermsConsumer addField(FieldInfo field) throws IOException;

  /** Called when we are done adding everything. */
  abstract void finish() throws IOException;
}