pylucene 3.5.0-3

[pylucene.git] / lucene-java-3.5.0 / lucene / src / java / org / apache / lucene / index / InvertedDocConsumerPerField.java

diff --git a/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/index/InvertedDocConsumerPerField.java b/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/index/InvertedDocConsumerPerField.java
new file mode 100644 (file)
index 0000000..cb7a333
--- /dev/null
+++ b/lucene-java-3.5.0/lucene/src/java/org/apache/lucene/index/InvertedDocConsumerPerField.java
@@ -0,0 +1,44 @@
+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;
+
+import org.apache.lucene.document.Fieldable;
+
+abstract class InvertedDocConsumerPerField {
+
+  // Called once per field, and is given all Fieldable
+  // occurrences for this field in the document.  Return
+  // true if you wish to see inverted tokens for these
+  // fields:
+  abstract boolean start(Fieldable[] fields, int count) throws IOException;
+
+  // Called before a field instance is being processed
+  abstract void start(Fieldable field);
+  
+  // Called once per inverted token
+  abstract void add() throws IOException;
+
+  // Called once per field per document, after all Fieldable
+  // occurrences are inverted
+  abstract void finish() throws IOException;
+
+  // Called on hitting an aborting exception
+  abstract void abort();
+}