Search/Lucene/Search/Query/Term.php
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 license@zend.com 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: Term.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Search_Query_Term
- 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 = 1
1
Details- Type
- float
- Inherited_from
- \Zend_Search_Lucene_Search_Query::$$_boost


integer $_currentColorIndex = 0
0
Details- Type
- integer
- Inherited_from
- \Zend_Search_Lucene_Search_Query::$$_currentColorIndex
Methods


__construct(\Zend_Search_Lucene_Index_Term $term) : void
Zend_Search_Lucene_Search_Query_Term constructor
Name | Type | Description |
---|---|---|
$term | \Zend_Search_Lucene_Index_Term |


_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : void
Query 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) : void
Constructs 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 |


createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight
Constructs 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) : void
Execute 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() : float
Gets 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 |


getTerm() : \Zend_Search_Lucene_Index_Term
Return query term
Type | Description |
---|---|
\Zend_Search_Lucene_Index_Term |


highlightMatches(string $inputHTML, string $defaultEncoding = '', \Zend_Search_Lucene_Search_Highlighter_Interface | null $highlighter = null) : string
Highlight 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) : string
Highlight 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() : array
Get 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_Query
Optimize query in the context of specified index
Name | Type | Description |
---|---|---|
$index | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\Zend_Search_Lucene_Search_Query |


reset() : void
Reset 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_Query
Re-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) : float
Score specified document
Name | Type | Description |
---|---|---|
$docId | integer | |
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
float |


setBoost(float $boost) : void
Sets the boost for this query clause to $boost.
Inherited from: \Zend_Search_Lucene_Search_Query::setBoost()Name | Type | Description |
---|---|---|
$boost | float |