The IndexSearcher type exposes the following members.

Constructors

  NameDescription
Public methodIndexSearcher(String) Obsolete.
Creates a searcher searching the index in the named directory.
Public methodIndexSearcher(Directory) Obsolete.
Creates a searcher searching the index in the provided directory.
Public methodIndexSearcher(IndexReader)
Creates a searcher searching the provided index.
Public methodIndexSearcher(String, Boolean) Obsolete.
Creates a searcher searching the index in the named directory. You should pass readOnly=true, since it gives much better concurrent performance, unless you intend to do write operations (delete documents or change norms) with the underlying IndexReader.
Public methodIndexSearcher(Directory, Boolean)
Creates a searcher searching the index in the named directory. You should pass readOnly=true, since it gives much better concurrent performance, unless you intend to do write operations (delete documents or change norms) with the underlying IndexReader.

Methods

  NameDescription
Public methodClose
Note that the underlying IndexReader is not closed, if IndexSearcher was constructed with IndexSearcher(IndexReader r). If the IndexReader was supplied implicitly by specifying a directory, then the IndexReader gets closed.
(Overrides Searcher..::..Close()()()().)
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodCreateWeight
creates a weight for
CopyC#
query
(Inherited from Searcher.)
Public methodDispose
.NET
(Overrides Searcher..::..Dispose()()()().)
Public methodDoc(Int32) (Overrides Searcher..::..Doc(Int32).)
Public methodDoc(Int32, FieldSelector) (Overrides Searcher..::..Doc(Int32, FieldSelector).)
Public methodDocFreq (Overrides Searcher..::..DocFreq(Term).)
Public methodDocFreqs (Inherited from Searcher.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExplain(Query, Int32)
Returns an Explanation that describes how
CopyC#
doc
 scored against
CopyC#
query
.

This is intended to be used in developing Similarity implementations, and, for good performance, should not be displayed with every hit. Computing an explanation is as expensive as executing the query over the entire index.

(Inherited from Searcher.)
Public methodExplain(Weight, Int32) (Overrides Searcher..::..Explain(Weight, Int32).)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGatherSubReaders
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIndexReader
Return the {@link IndexReader} this searches.
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetSimilarity
Expert: Return the Similarity implementation used by this Searcher.

This defaults to the current value of {@link Similarity#GetDefault()}.

(Inherited from Searcher.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodMaxDoc (Overrides Searcher..::..MaxDoc()()()().)
Protected methodMemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Public methodRewrite (Overrides Searcher..::..Rewrite(Query).)
Public methodSearch(Query) Obsolete.
Returns the documents matching
CopyC#
query
.
(Inherited from Searcher.)
Public methodSearch(Query, Collector)
Lower-level search API.

{@link 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 ({@link Searcher#Search(Query, int)} ) is usually more efficient, as it skips non-high-scoring hits.

Note: The

CopyC#
score
passed to this method is a raw score. In other words, the score will not necessarily be a float whose value is between 0 and 1.
(Inherited from Searcher.)
Public methodSearch(Query, Filter) Obsolete.
Returns the documents matching
CopyC#
query
 and
CopyC#
filter
.
(Inherited from Searcher.)
Public methodSearch(Query, HitCollector) Obsolete.
Lower-level search API.

{@link HitCollector#Collect(int,float)} is called for every matching document.

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

Note: The

CopyC#
score
passed to this method is a raw score. In other words, the score will not necessarily be a float whose value is between 0 and 1.
(Inherited from Searcher.)
Public methodSearch(Query, Sort) Obsolete.
Returns documents matching
CopyC#
query
 sorted by
CopyC#
sort
.
(Inherited from Searcher.)
Public methodSearch(Query, Int32)
Finds the top
CopyC#
n
 hits for
CopyC#
query
.
(Inherited from Searcher.)
Public methodSearch(Query, Filter, Collector)
Lower-level search API.

{@link Collector#Collect(int)} is called for every matching document.
Collector-based access to remote indexes is discouraged.

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

(Inherited from Searcher.)
Public methodSearch(Query, Filter, HitCollector) Obsolete.
Lower-level search API.

{@link HitCollector#Collect(int,float)} is called for every matching document.
HitCollector-based access to remote indexes is discouraged.

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

(Inherited from Searcher.)
Public methodSearch(Query, Filter, Sort) Obsolete.
Returns documents matching
CopyC#
query
 and
CopyC#
filter
, sorted by
CopyC#
sort
.
(Inherited from Searcher.)
Public methodSearch(Query, Filter, Int32)
Finds the top
CopyC#
n
 hits for
CopyC#
query
, applying
CopyC#
filter
 if non-null.
(Inherited from Searcher.)
Public methodSearch(Weight, Filter, Collector) (Overrides Searcher..::..Search(Weight, Filter, Collector).)
Public methodSearch(Weight, Filter, Int32) (Overrides Searcher..::..Search(Weight, Filter, Int32).)
Public methodSearch(Weight, Filter, HitCollector) Obsolete. (Inherited from Searcher.)
Public methodSearch(Query, Filter, Int32, Sort)
Search implementation with arbitrary sorting. Finds the top
CopyC#
n
 hits for
CopyC#
query
, applying
CopyC#
filter
 if non-null, and sorting the hits by the criteria in
CopyC#
sort
.

NOTE: this does not compute scores by default; use {@link IndexSearcher#setDefaultFieldSortScoring} to enable scoring.

(Inherited from Searcher.)
Public methodSearch(Weight, Filter, Int32, Sort) (Overrides Searcher..::..Search(Weight, Filter, Int32, Sort).)
Public methodSearch(Weight, Filter, Int32, Sort, Boolean)
Just like {@link #Search(Weight, Filter, int, Sort)}, but you choose whether or not the fields in the returned {@link FieldDoc} instances should be set by specifying fillFields.

NOTE: this does not compute scores by default. If you need scores, create a {@link TopFieldCollector} instance by calling {@link TopFieldCollector#create} and then pass that to {@link #Search(Weight, Filter, Collector)}.

Public methodSetDefaultFieldSortScoring
By default, no scores are computed when sorting by field (using {@link #Search(Query,Filter,int,Sort)}). You can change that, per IndexSearcher instance, by calling this method. Note that this will incur a CPU cost.
Public methodSetSimilarity
Expert: Set the Similarity implementation used by this Searcher.
(Inherited from Searcher.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

Properties

  NameDescription
Public propertyreader_ForNUnit

See Also