Search/Lucene/Search/Query/Phrase.php
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Search
- Version
- $Id: Phrase.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Search_Query_Phrase
A Query that matches documents containing a particular sequence of terms.
- Parent(s)
- \Zend_Search_Lucene_Search_Query
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
float $_boost = 11Details- Type
- float
- Inherited_from
- \Zend_Search_Lucene_Search_Query::$$_boost
integer $_currentColorIndex = 0Current highlight color
Inherited from: \Zend_Search_Lucene_Search_Query::$$_currentColorIndex0Details- Type
- integer
- Inherited_from
- \Zend_Search_Lucene_Search_Query::$$_currentColorIndex
array $_offsets = Term positions (relative positions of terms within the phrase).
Array of integers
- Type
- array
array $_resVector = nullResult vector.
nullDetails- Type
- array
integer $_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 WITHIN or 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.
- Type
- integer
array $_terms = Terms to find.
Array of Zend_Search_Lucene_Index_Term objects.
- Type
- array
array $_termsPositions = array()Terms positions vectors.
Array of Arrays: term1Id => (docId => array( pos1, pos2, ... ), ...) term2Id => (docId => array( pos1, pos2, ... ), ...)
array()Details- Type
- array
\Zend_Search_Lucene_Search_Weight $_weight = null
nullDetails- Type
- \Zend_Search_Lucene_Search_Weight
- Inherited_from
- \Zend_Search_Lucene_Search_Query::$$_weight
Methods
__construct(array $terms = null, array $offsets = null, string $field = null) : voidClass constructor.
Create a new prase query.
| Name | Type | Description |
|---|---|---|
| $terms | array | Terms to search Array of strings. |
| $offsets | array | Relative term positions. Array of integers. |
| $field | string | Field to search. |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
__toString() : stringPrint a query
| Type | Description |
|---|---|
| string |
_exactPhraseFreq(integer $docId) : floatScore calculator for exact phrase queries (terms sequence is fixed)
| Name | Type | Description |
|---|---|---|
| $docId | integer |
| Type | Description |
|---|---|
| float |
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : voidQuery specific matches highlighting
| Name | Type | Description |
|---|---|---|
| $highlighter | \Zend_Search_Lucene_Search_Highlighter_Interface | Highlighter object (also contains doc for highlighting) |
_initWeight(\Zend_Search_Lucene_Interface $reader) : voidConstructs an initializes a Weight for a _top-level_query_.
Inherited from: \Zend_Search_Lucene_Search_Query::_initWeight()| Name | Type | Description |
|---|---|---|
| $reader | \Zend_Search_Lucene_Interface |
_sloppyPhraseFreq(integer $docId, \Zend_Search_Lucene_Interface $reader) : floatScore calculator for sloppy phrase queries (terms sequence is fixed)
| Name | Type | Description |
|---|---|---|
| $docId | integer | |
| $reader | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| float |
addTerm(\Zend_Search_Lucene_Index_Term $term, integer $position = null) : voidAdds a term to the end of the query phrase.
The relative position of the term is specified explicitly or the one immediately after the last term added.
| Name | Type | Description |
|---|---|---|
| $term | \Zend_Search_Lucene_Index_Term | |
| $position | integer |
createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_WeightConstructs an appropriate Weight implementation for this query.
| Name | Type | Description |
|---|---|---|
| $reader | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Search_Weight |
execute(\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : voidExecute query in context of index reader It also initializes necessary internal structures
Query specific implementation
| Name | Type | Description |
|---|---|---|
| $reader | \Zend_Search_Lucene_Interface | |
| $docsFilter | \Zend_Search_Lucene_Index_DocsFilter | null |
getBoost() : floatGets the boost for this clause.
Inherited from: \Zend_Search_Lucene_Search_Query::getBoost()Documents matching this clause will (in addition to the normal weightings) have their score multiplied by boost. The boost is 1.0 by default.
| Type | Description |
|---|---|
| float |
getQueryTerms() : arrayReturn query terms
| Type | Description |
|---|---|
| array |
getSlop() : integerGet slop
| Type | Description |
|---|---|
| integer |
getTerms() : arrayReturns query term
| Type | Description |
|---|---|
| array |
highlightMatches(string $inputHTML, string $defaultEncoding = '', \Zend_Search_Lucene_Search_Highlighter_Interface | null $highlighter = null) : stringHighlight matches in $inputHTML
Inherited from: \Zend_Search_Lucene_Search_Query::highlightMatches()| Name | Type | Description |
|---|---|---|
| $inputHTML | string | |
| $defaultEncoding | string | HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag. |
| $highlighter | \Zend_Search_Lucene_Search_Highlighter_Interface | null |
| Type | Description |
|---|---|
| string |
htmlFragmentHighlightMatches(string $inputHtmlFragment, string $encoding = 'UTF-8', \Zend_Search_Lucene_Search_Highlighter_Interface | null $highlighter = null) : stringHighlight matches in $inputHtmlFragment and return it (without HTML header and body tag)
Inherited from: \Zend_Search_Lucene_Search_Query::htmlFragmentHighlightMatches()| Name | Type | Description |
|---|---|---|
| $inputHtmlFragment | string | |
| $encoding | string | Input HTML string encoding |
| $highlighter | \Zend_Search_Lucene_Search_Highlighter_Interface | null |
| Type | Description |
|---|---|
| string |
matchedDocs() : arrayGet document ids likely matching the query
It's an array with document ids as keys (performance considerations)
| Type | Description |
|---|---|
| array |
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_QueryOptimize query in the context of specified index
| Name | Type | Description |
|---|---|---|
| $index | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Search_Query |
reset() : voidReset query, so it can be reused within other queries or with other indeces
Inherited from: \Zend_Search_Lucene_Search_Query::reset()rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_QueryRe-write query into primitive queries in the context of specified index
| Name | Type | Description |
|---|---|---|
| $index | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Search_Query |
score(integer $docId, \Zend_Search_Lucene_Interface $reader) : floatScore specified document
| Name | Type | Description |
|---|---|---|
| $docId | integer | |
| $reader | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| float |
setBoost(float $boost) : voidSets the boost for this query clause to $boost.
Inherited from: \Zend_Search_Lucene_Search_Query::setBoost()| Name | Type | Description |
|---|---|---|
| $boost | float |
setSlop(integer $slop) : voidSet slop
| Name | Type | Description |
|---|---|---|
| $slop | integer |
setWeight(integer $num, \Zend_Search_Lucene_Search_Weight_Term $weight) : voidSet weight for specified term
| Name | Type | Description |
|---|---|---|
| $num | integer | |
| $weight | \Zend_Search_Lucene_Search_Weight_Term |