beagled/Lucene.Net/Index/TermPositions.cs

   1 /*
   2  * Copyright 2004 The Apache Software Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 using System;
  17 namespace Lucene.Net.Index
  18 {
  19
  20         /// <summary> TermPositions provides an interface for enumerating the &lt;document,
  21         /// frequency, &lt;position&gt;* &gt; tuples for a term.  <p> The document and
  22         /// frequency are the same as for a TermDocs.  The positions portion lists the ordinal
  23         /// positions of each occurrence of a term in a document.
  24         ///
  25         /// </summary>
  26         /// <seealso cref="IndexReader#TermPositions()">
  27         /// </seealso>
  28
  29         public interface TermPositions:TermDocs
  30         {
  31                 /// <summary>Returns next position in the current document.  It is an error to call
  32                 /// this more than {@link #Freq()} times
  33                 /// without calling {@link #Next()}<p> This is
  34                 /// invalid until {@link #Next()} is called for
  35                 /// the first time.
  36                 /// </summary>
  37                 int NextPosition();
  38         }
  39 }