1 package org.apache.lucene.index;
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 import java.io.IOException;
22 import org.apache.lucene.document.Fieldable;
24 abstract class InvertedDocConsumerPerField {
26 // Called once per field, and is given all Fieldable
27 // occurrences for this field in the document. Return
28 // true if you wish to see inverted tokens for these
30 abstract boolean start(Fieldable[] fields, int count) throws IOException;
32 // Called before a field instance is being processed
33 abstract void start(Fieldable field);
35 // Called once per inverted token
36 abstract void add() throws IOException;
38 // Called once per field per document, after all Fieldable
39 // occurrences are inverted
40 abstract void finish() throws IOException;
42 // Called on hitting an aborting exception
43 abstract void abort();