The PhraseQuery type exposes the following members.

Methods

  NameDescription
Public methodAdd(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.
Public methodAdd(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).
Public methodClone
Returns a clone of this query.
(Inherited from Query.)
Public methodCombine
Expert: called when re-writing queries under MultiSearcher. Create a single query suitable for use by all subsearchers (in 1-1 correspondence with queries). This is an optimization of the OR of all queries. We handle the common optimization cases of equal queries and overlapping clauses of boolean OR queries (as generated by MultiTermQuery.rewrite()). Be careful overriding this method as queries[0] determines which method will be called and is not necessarily of the same type as the other queries.
(Inherited from Query.)
Public methodCreateWeight (Overrides Query..::..CreateWeight(Searcher).)
Public methodEquals
Returns true iff
CopyC#
o
is equal to this.
(Overrides Query..::..Equals(Object).)
Public methodExtractTerms (Overrides Query..::..ExtractTerms(Hashtable).)
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 methodGetBoost
Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by
CopyC#
b
. The boost is 1.0 by default.
(Inherited from Query.)
Public methodGetHashCode
Returns a hash code value for this object.
(Overrides Query..::..GetHashCode()()()().)
Public methodGetPositions
Returns the relative positions of terms in this phrase.
Public methodGetSimilarity
Expert: Returns the Similarity implementation to be used for this query. Subclasses may override this method to specify their own Similarity implementation, perhaps one that delegates through that of the Searcher. By default the Searcher's Similarity implementation is returned.
(Inherited from Query.)
Public methodGetSlop
Returns the slop. See setSlop().
Public methodGetTerms
Returns the set of terms in this phrase.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRewrite
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.
(Inherited from Query.)
Public methodSetBoost
Sets the boost for this query clause to
CopyC#
b
. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by
CopyC#
b
.
(Inherited from Query.)
Public methodSetSlop
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
CopyC#
WITHIN
or
CopyC#
NEAR
operator.

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.

Public methodToString()()()()
Prints a query to a string.
(Inherited from Query.)
Public methodToString(String)
Prints a user-readable version of this query.
(Overrides Query..::..ToString(String).)
Public methodWeight
Expert: Constructs and initializes a Weight for a top-level query.
(Inherited from Query.)

See Also