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. A TermPositionVector not necessarily
  22     /// contains both positions and offsets, but at least one of these arrays exists.
  23     /// </summary>
  24     public interface TermPositionVector : TermFreqVector
  25         {
  26
  27         /// <summary>Returns an array of positions in which the term is found.
  28         /// Terms are identified by the index at which its number appears in the
  29         /// term String array obtained from the <code>indexOf</code> method.
  30         /// May return null if positions have not been stored.
  31         /// </summary>
  32         int[] GetTermPositions(int index);
  33
  34         /// <summary> Returns an array of TermVectorOffsetInfo in which the term is found.
  35         /// May return null if offsets have not been stored.
  36         ///
  37         /// </summary>
  38         /// <seealso cref="Lucene.Net.analysis.Token">
  39         ///
  40         /// </seealso>
  41         /// <param name="index">The position in the array to get the offsets from
  42         /// </param>
  43         /// <returns> An array of TermVectorOffsetInfo objects or the empty list
  44         /// </returns>
  45         TermVectorOffsetInfo[] GetOffsets(int index);
  46     }
  47 }