The Searcher type exposes the following members.

Constructors

  NameDescription
Public methodSearcher
Initializes a new instance of the Searcher class

Methods

  NameDescription
Public methodClose
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
Public methodDispose
Releases all resources used by the Searcher
Public methodDoc(Int32)
Public methodDoc(Int32, FieldSelector)
Public methodDocFreq
Public methodDocFreqs
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.

Public methodExplain(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.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
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()}.

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
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
Public methodSearch(Query) Obsolete.
Returns the documents matching
CopyC#
query
.
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.
Public methodSearch(Query, Filter) Obsolete.
Returns the documents matching
CopyC#
query
and
CopyC#
filter
.
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.
Public methodSearch(Query, Sort) Obsolete.
Returns documents matching
CopyC#
query
sorted by
CopyC#
sort
.
Public methodSearch(Query, Int32)
Finds the top
CopyC#
n
hits for
CopyC#
query
.
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.

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.

Public methodSearch(Query, Filter, Sort) Obsolete.
Returns documents matching
CopyC#
query
and
CopyC#
filter
, sorted by
CopyC#
sort
.
Public methodSearch(Query, Filter, Int32)
Finds the top
CopyC#
n
hits for
CopyC#
query
, applying
CopyC#
filter
if non-null.
Public methodSearch(Weight, Filter, Collector)
Public methodSearch(Weight, Filter, HitCollector) Obsolete.
Public methodSearch(Weight, Filter, Int32)
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.

Public methodSearch(Weight, Filter, Int32, Sort)
Public methodSetSimilarity
Expert: Set the Similarity implementation used by this Searcher.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

See Also