lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gol...@apache.org
Subject cvs commit: jakarta-lucene/src/java/org/apache/lucene/search WildcardTermEnum.java FuzzyTermEnum.java FilteredTermEnum.java
Date Tue, 23 Nov 2004 19:22:25 GMT
goller      2004/11/23 11:22:25

  Modified:    src/java/org/apache/lucene/search WildcardTermEnum.java
                        FuzzyTermEnum.java FilteredTermEnum.java
  Log:
  Javadoc correction as suggested by Bug#32353
  
  Revision  Changes    Path
  1.11      +4 -1      jakarta-lucene/src/java/org/apache/lucene/search/WildcardTermEnum.java
  
  Index: WildcardTermEnum.java
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/WildcardTermEnum.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- WildcardTermEnum.java	23 Sep 2004 16:43:47 -0000	1.10
  +++ WildcardTermEnum.java	23 Nov 2004 19:22:24 -0000	1.11
  @@ -42,6 +42,9 @@
      * Creates a new <code>WildcardTermEnum</code>.  Passing in a
      * {@link org.apache.lucene.index.Term Term} that does not contain a
      * <code>WILDCARD_CHAR</code> will cause an exception to be thrown.
  +   * <p>
  +   * After calling the constructor the enumeration is already pointing to the first 
  +   * valid term if such a term exists.
      */
     public WildcardTermEnum(IndexReader reader, Term term) throws IOException {
       super();
  
  
  
  1.13      +10 -1     jakarta-lucene/src/java/org/apache/lucene/search/FuzzyTermEnum.java
  
  Index: FuzzyTermEnum.java
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/FuzzyTermEnum.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- FuzzyTermEnum.java	23 Nov 2004 19:05:15 -0000	1.12
  +++ FuzzyTermEnum.java	23 Nov 2004 19:22:24 -0000	1.13
  @@ -54,6 +54,9 @@
   
     /**
      * Creates a FuzzyTermEnum with an empty prefix and a minSimilarity of 0.5f.
  +   * <p>
  +   * After calling the constructor the enumeration is already pointing to the first 
  +   * valid term if such a term exists. 
      * 
      * @param reader
      * @param term
  @@ -66,6 +69,9 @@
       
     /**
      * Creates a FuzzyTermEnum with an empty prefix.
  +   * <p>
  +   * After calling the constructor the enumeration is already pointing to the first 
  +   * valid term if such a term exists. 
      * 
      * @param reader
      * @param term
  @@ -80,7 +86,10 @@
     /**
      * Constructor for enumeration of all terms from specified <code>reader</code>
which share a prefix of
      * length <code>prefixLength</code> with <code>term</code> and
which have a fuzzy similarity &gt;
  -   * <code>minSimilarity</code>. 
  +   * <code>minSimilarity</code>.
  +   * <p>
  +   * After calling the constructor the enumeration is already pointing to the first 
  +   * valid term if such a term exists. 
      * 
      * @param reader Delivers terms.
      * @param term Pattern term.
  
  
  
  1.8       +2 -2      jakarta-lucene/src/java/org/apache/lucene/search/FilteredTermEnum.java
  
  Index: FilteredTermEnum.java
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/FilteredTermEnum.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- FilteredTermEnum.java	6 Oct 2004 16:19:51 -0000	1.7
  +++ FilteredTermEnum.java	23 Nov 2004 19:22:24 -0000	1.8
  @@ -50,7 +50,7 @@
       
       /** 
        * Returns the docFreq of the current Term in the enumeration.
  -     * Initially invalid, valid after next() called for the first time. 
  +     * Returns -1 if no Term matches or all terms have been enumerated.
        */
       public int docFreq() {
           if (actualEnum == null) return -1;
  @@ -77,7 +77,7 @@
       }
       
       /** Returns the current Term in the enumeration.
  -     * Initially invalid, valid after next() called for the first time. */
  +     * Returns null if no Term matches or all terms have been enumerated. */
       public Term term() {
           return currentTerm;
       }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Mime
View raw message