beagled/Lucene.Net/Index/TermPositionVector.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>Extends <code>TermFreqVector</code> to provide additional information about
  21         /// positions in which each of the terms is found.
  22         /// </summary>
  23         public interface TermPositionVector:TermFreqVector
  24         {
  25
  26                 /// <summary>Returns an array of positions in which the term is found.
  27                 /// Terms are identified by the index at which its number appears in the
  28                 /// term number array obtained from <code>getTermNumbers</code> method.
  29                 /// </summary>
  30                 int[] GetTermPositions(int index);
  31         }
  32 }