Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | Properties | List of all members
Lucene.Net.Search.PrefixFilter Class Reference

A Filter that restricts search results to values that have a matching prefix in a given field. More...

Inherits Lucene.Net.Search.MultiTermQueryWrapperFilter< T >.

Public Member Functions

 PrefixFilter (Term prefix)
override System.String ToString ()
 Prints a user-readable version of this query.
- Public Member Functions inherited from Lucene.Net.Search.MultiTermQueryWrapperFilter< T >
override System.String ToString ()
override bool Equals (System.Object o)
override int GetHashCode ()
virtual void ClearTotalNumberOfTerms ()
 Expert: Resets the counting of unique terms. Do this before executing the filter.
override DocIdSet GetDocIdSet (IndexReader reader)


virtual Term Prefix [get]
- Properties inherited from Lucene.Net.Search.MultiTermQueryWrapperFilter< T >
virtual int TotalNumberOfTerms [get]
 Expert: Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index. This method is not thread safe, be sure to only call it when no filter is running! If you re-use the same filter instance for another search, be sure to first reset the term counter with ClearTotalNumberOfTerms.

Detailed Description

A Filter that restricts search results to values that have a matching prefix in a given field.

Definition at line 29 of file PrefixFilter.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.PrefixFilter.PrefixFilter ( Term  prefix)

Definition at line 32 of file PrefixFilter.cs.

Member Function Documentation

override System.String Lucene.Net.Search.PrefixFilter.ToString ( )

Prints a user-readable version of this query.

Definition at line 42 of file PrefixFilter.cs.

Property Documentation

virtual Term Lucene.Net.Search.PrefixFilter.Prefix

Definition at line 37 of file PrefixFilter.cs.

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