Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

javadoc: fix Terms.totalTermFreq desc 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1143155 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yonik Seeley 2011-07-05 18:04:27 +00:00
parent acd4af384c
commit c30b8d6cd8
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lucene/src/java/org/apache/lucene/index/Terms.java
View File

@ -57,9 +57,12 @@ public abstract class Terms {
}
}
/** Returns the number of documents containing the
* specified term text. Returns 0 if the term does not
* exist. */
/** Returns the total number of occurrences of this term
* across all documents (the sum of the freq() for each
* doc that has this term). This will be -1 if the
* codec doesn't support this measure. Note that, like
* other term measures, this measure does not take
* deleted documents into account. */
public long totalTermFreq(BytesRef text) throws IOException {
final TermsEnum termsEnum = getThreadTermsEnum();
if (termsEnum.seekExact(text, true)) {