improve IndexSearcher javadocs: TotalHitCountCollector and paging [LUCENE-3799]
Open
legacy-jira-fix-version:4.9
legacy-jira-fix-version:6.0
legacy-jira-priority:Major
type:task
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
The javadocs is so skimpy here that its somewhat of a trap.
I think for the class javadocs, we can have a few 'recommendations' like:
- Use is.search() for the normal search case [users viewing top few pages]
- Use is.search() + TotalHitCountCollector if you only want the total number of hits
- Use is.searchAfter() if you allow users to page deeply.
---
Migrated from [LUCENE-3799](https://issues.apache.org/jira/browse/LUCENE-3799) by Robert Muir (@rmuir), updated May 09 2016
Contributor guide
Assessment
This issue has not been assessed yet.