TermPositions.java
01 package gate.creole.annic.apache.lucene.index;
02 
03 /**
04  * Copyright 2004 The Apache Software Foundation
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 import java.io.IOException;
20 
21 /**
22  * TermPositions provides an interface for enumerating the <document,
23  * frequency, &lt;position&gt;* &gt; tuples for a term.  <p> The document and
24  * frequency are the same as for a TermDocs.  The positions portion lists the ordinal
25  * positions of each occurrence of a term in a document.
26  *
27  @see IndexReader#termPositions
28  */
29 
30 public interface TermPositions
31     extends TermDocs
32 {
33     /** Returns next position in the current document.  It is an error to call
34   this more than {@link #freq()} times
35   without calling {@link #next()}<p> This is
36   invalid until {@link #next()} is called for
37   the first time.
38     */
39     int nextPosition() throws IOException;
40 }