lucene4.x收集器之TopDocsCollector

TopDocsCollector

        是所有返回TopDocs的收集器的抽象基类。在收集完成后，根据一些条件收集前N个结果。这个收集器通过提供一个构造器来实现简单的扩展，构造器接受一个PriorityQueue以及该优先队列的受保护成员和总命中数的计数器。扩展类可以覆盖任何方法来提供它们自己的实现，同时可以通过将null传递给TopDocsCollector(PriorityQueue)来避免使用优先队列。但是这种情况下，可能要覆盖所有的方法来避免NullPointerException。
        PriorityQueue<T> pq：持有“顶级文档”的优先队列。PriorityQueue的不同实现，对“顶级文档”有不同的定义。如TopDocsCollector的抽象子类TopScoreDocCollector使用的HitQueue是按评分进行排序的，而其他的实现可能按其他的标准进行排序。
        totalHits：匹配查询的文档总数。
        populateResults(ScoreDoc[] results, int howMany)：用ScoreDoc实例填充结果数组。如果要返回不同类型的ScoreDoc可以覆盖此方法。
        newTopDocs(ScoreDoc[] results, int start)：返回一个包含给定results的TopDocs实例。如果results为null说明没有结果返回，可能是因为没有调用collect()或者topDocs的参数是无效的。
        topDocs()：返回收集器队列中的所有文档。
        topDocs(int start)：返回收集器队列中[start,pq.size())范围的文档。如果start大于pq.size()，则返回一个空的TopDocs。如果总是要求返回最后一页的结果，这种方法很方便调用。对于每次搜索这个方法只能调用一次。如果想通过每次传递不同的start来调用多次，应该调用topDocs()并与返回的包含本次搜索收集的所有结果的TopDocs对象一起来实现。

        topDocs(int start, int howMany)：返回收集器队列中[start,start+howMany)范围的文档。如果start大于pq.size()，则返回一个空的TopDocs。如果start+howMany大于pq.size()，则只返回[start,pq.size())范围的文档。在搜索结果分页以及通过需要设置howMany来优化内存的使用时很有用。