Class PhraseQuery
A Query that matches documents containing a particular sequence of terms.
A PhraseQuery is built by QueryParser for input like "new york".
This query may be combined with other terms or queries with a BooleanQuery.
Inherited Members
Namespace:
Assembly: Lucene.Net.NetCore.dll
Syntax
public class PhraseQuery : QueryConstructors
| Name | Description |
|---|---|
| PhraseQuery() | Constructs an empty phrase query. |
Properties
| Name | Description |
|---|---|
| Slop | Sets the number of other words permitted between words in query phrase.
If zero, then this is an exact phrase search. For larger values this works
like a The slop is in fact an edit-distance, where the units correspond to moves of terms in the query phrase out of position. For example, to switch the order of two words requires two moves (the first move places the words atop one another), so to permit re-orderings of phrases, the slop must be at least two. More exact matches are scored higher than sloppier matches, thus search results are sorted by exactness. The slop is zero by default, requiring exact matches. |
Methods
| Name | Description |
|---|---|
| Add(Term) | Adds a term to the end of the query phrase. The relative position of the term is the one immediately after the last term added. |
| Add(Term, Int32) | Adds a term to the end of the query phrase. The relative position of the term within the phrase is specified explicitly. This allows e.g. phrases with more than one term at the same position or phrases with gaps (e.g. in connection with stopwords). |
| CreateWeight(Searcher) | |
| Equals(Object) | Returns true iff |
| ExtractTerms(Collections.Generic.ISet<Term>) | |
| GetHashCode() | Returns a hash code value for this object. |
| GetPositions() | Returns the relative positions of terms in this phrase. |
| GetTerms() | Returns the set of terms in this phrase. |
| ToString(String) | Prints a user-readable version of this query. |