Package org.apache.lucene.search.knn
Interface KnnCollectorManager
- All Known Implementing Classes:
TimeLimitingKnnCollectorManager,TopKnnCollectorManager
public interface KnnCollectorManager
KnnCollectorManager responsible for creating
KnnCollector instances. Useful to create
KnnCollector instances that share global state across leaves, such a global queue of
results collected so far.-
Method Summary
Modifier and TypeMethodDescriptiondefault booleannewCollector(int visitedLimit, KnnSearchStrategy searchStrategy, LeafReaderContext context) Return a newKnnCollectorinstance.default KnnCollectornewOptimisticCollector(int visitedLimit, KnnSearchStrategy searchStrategy, LeafReaderContext context, int k) Return a newKnnCollectorinstance, generally with a specific k value, scaled per leaf statistics
-
Method Details
-
newCollector
KnnCollector newCollector(int visitedLimit, KnnSearchStrategy searchStrategy, LeafReaderContext context) throws IOException Return a newKnnCollectorinstance.- Parameters:
visitedLimit- the maximum number of nodes that the search is allowed to visitsearchStrategy- the optional search strategy configurationcontext- the leaf reader context- Throws:
IOException
-
newOptimisticCollector
default KnnCollector newOptimisticCollector(int visitedLimit, KnnSearchStrategy searchStrategy, LeafReaderContext context, int k) throws IOException Return a newKnnCollectorinstance, generally with a specific k value, scaled per leaf statistics- Parameters:
visitedLimit- the maximum number of nodes that the search is allowed to visitsearchStrategy- the optional search strategy configurationcontext- the leaf reader contextk- the number of neighbors to collect, this is the expected number of results- Returns:
- a new KnnCollector instance
- Throws:
IOException- if there is an error creating the collector
-
isOptimistic
default boolean isOptimistic()
-