Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Classes | Public Member Functions | List of all members
Lucene.Net.Search.ParallelMultiSearcher Class Reference

Implements parallel search over a set of Searchables. More...

Inherits Lucene.Net.Search.MultiSearcher.

Public Member Functions

 ParallelMultiSearcher (params Searchable[] searchables)
 Creates a Searchable which searches searchables.
 
override int DocFreq (Term term)
 Executes each Searchable's docFreq() in its own thread and waits for each search to complete and merge the results back together.
 
override TopDocs Search (Weight weight, Filter filter, int nDocs)
 A search implementation which executes each Searchable in its own thread and waits for each search to complete and merge the results back together.
 
override TopFieldDocs Search (Weight weight, Filter filter, int nDocs, Sort sort)
 A search implementation allowing sorting which spans a new thread for each Searchable, waits for each search to complete and merges the results back together.
 
override void Search (Weight weight, Filter filter, Collector collector)
 Lower-level search API.
 
- Public Member Functions inherited from Lucene.Net.Search.MultiSearcher
 MultiSearcher (params Searchable[] searchables)
 Creates a searcher which searches searchers.
 
virtual Searchable[] GetSearchables ()
 Return the array of Searchables this searches.
 
override Document Doc (int n)
 Expert: Returns the stored fields of document i.
 
override Document Doc (int n, FieldSelector fieldSelector)
 Get the Lucene.Net.Documents.Documentat the nth position. The Lucene.Net.Documents.FieldSelector may be used to determine what Lucene.Net.Documents.Fields to load and how they should be loaded.
 
virtual int SubSearcher (int n)
 Returns index of the searcher for document n in the array used to construct this searcher.
 
virtual int SubDoc (int n)
 Returns the document number of document n within its sub-index.
 
override Query Rewrite (Query original)
 Expert: called to re-write queries into primitive queries.
 
override Explanation Explain (Weight weight, int doc)
 Expert: low-level implementation method Returns an Explanation that describes how doc scored against weight.
 
override Weight CreateWeight (Query original)
 Create weight in multiple index scenario.
 
- Public Member Functions inherited from Lucene.Net.Search.Searcher
virtual TopFieldDocs Search (Query query, Filter filter, int n, Sort sort)
 Search implementation with arbitrary sorting. Finds the top n hits for query, applying filter if non-null, and sorting the hits by the criteria in sort.
 
virtual void Search (Query query, Collector results)
 Lower-level search API.
 
virtual void Search (Query query, Filter filter, Collector results)
 Lower-level search API.
 
virtual TopDocs Search (Query query, Filter filter, int n)
 Finds the top n hits for query, applying filter if non-null.
 
virtual TopDocs Search (Query query, int n)
 Finds the top n hits for query.
 
virtual Explanation Explain (Query query, int doc)
 Returns an Explanation that describes how doc scored against query.
 
virtual int[] DocFreqs (Term[] terms)
 Expert: For each term in the terms array, calculates the number of documents containing term. Returns an array with these document frequencies. Used to minimize number of remote calls.
 
void Close ()
 Frees resources associated with this Searcher. Be careful not to call this method while you are still using objects that reference this searchable
 
void Dispose ()
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene.Net.Search.MultiSearcher
override void Dispose (bool disposing)
 
- Properties inherited from Lucene.Net.Search.MultiSearcher
override int MaxDoc [get]
 

Detailed Description

Implements parallel search over a set of Searchables.

Applications usually need only call the inherited Searcher.Search(Query, int) or Searcher.Search(Query,Filter,int) methods.

Definition at line 36 of file ParallelMultiSearcher.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.ParallelMultiSearcher.ParallelMultiSearcher ( params Searchable[]  searchables)

Creates a Searchable which searches searchables.

Definition at line 84 of file ParallelMultiSearcher.cs.

Member Function Documentation

override int Lucene.Net.Search.ParallelMultiSearcher.DocFreq ( Term  term)
virtual

Executes each Searchable's docFreq() in its own thread and waits for each search to complete and merge the results back together.

Reimplemented from Lucene.Net.Search.MultiSearcher.

Definition at line 95 of file ParallelMultiSearcher.cs.

override TopDocs Lucene.Net.Search.ParallelMultiSearcher.Search ( Weight  weight,
Filter  filter,
int  nDocs 
)
virtual

A search implementation which executes each Searchable in its own thread and waits for each search to complete and merge the results back together.

Reimplemented from Lucene.Net.Search.MultiSearcher.

Definition at line 112 of file ParallelMultiSearcher.cs.

override TopFieldDocs Lucene.Net.Search.ParallelMultiSearcher.Search ( Weight  weight,
Filter  filter,
int  nDocs,
Sort  sort 
)
virtual

A search implementation allowing sorting which spans a new thread for each Searchable, waits for each search to complete and merges the results back together.

Reimplemented from Lucene.Net.Search.MultiSearcher.

Definition at line 149 of file ParallelMultiSearcher.cs.

override void Lucene.Net.Search.ParallelMultiSearcher.Search ( Weight  weight,
Filter  filter,
Collector  collector 
)
virtual

Lower-level search API.

Collector.Collect(int) is called for every matching document.

Applications should only use this if they need all of the matching documents. The high-level search API (Searcher.Search(Query, int)) is usually more efficient, as it skips non-high-scoring hits.

This method cannot be parallelized, because Collector supports no concurrent access.

Parameters
weightto match documents
filterif non-null, a bitset used to eliminate some documents
collectorto receive hits

TODO: parallelize this one too

Reimplemented from Lucene.Net.Search.MultiSearcher.

Definition at line 202 of file ParallelMultiSearcher.cs.


The documentation for this class was generated from the following file: