TermFreqVector.java
01 package gate.creole.annic.apache.lucene.index;
02 
03 /** Provides access to stored term vector of
04  *  a document field.
05  */
06 public interface TermFreqVector {
07   /**
08    *
09    @return The field this vector is associated with.
10    *
11    */
12   public String getField();
13 
14   /**
15    @return The number of terms in the term vector.
16    */
17   public int size();
18 
19   /**
20    @return An Array of term texts in ascending order.
21    */
22   public String[] getTerms();
23 
24 
25   /** Array of term frequencies. Locations of the array correspond one to one
26    *  to the terms in the array obtained from <code>getTerms</code>
27    *  method. Each location in the array contains the number of times this
28    *  term occurs in the document or the document field.
29    */
30   public int[] getTermFrequencies();
31 
32 
33   /** Return an index in the term numbers array returned from
34    *  <code>getTerms</code> at which the term with the specified
35    *  <code>term</code> appears. If this term does not appear in the array,
36    *  return -1.
37    */
38   public int indexOf(String term);
39 
40 
41   /** Just like <code>indexOf(int)</code> but searches for a number of terms
42    *  at the same time. Returns an array that has the same size as the number
43    *  of terms searched for, each slot containing the result of searching for
44    *  that term number.
45    *
46    *  @param terms array containing terms to look for
47    *  @param start index in the array where the list of terms starts
48    *  @param len the number of terms in the list
49    */
50   public int[] indexesOf(String[] terms, int start, int len);
51 
52 }