Search/Lucene/Search/Query/Boolean.php
Show:
inherited
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 license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Subpackage
- Search
- Version
- $Id$
\Zend_Search_Lucene_Search_Query_Boolean
Package: Zend_Search_Lucene\Search
- Parent(s)
- \Zend_Search_Lucene_Search_Query
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
mixed $_coord = nullA score factor based on the fraction of all query subqueries
that a document contains.
float for conjunction queries
array of float for non conjunction queries
Default valuenullDetails- Type
- mixed
array $_resVector = nullResult vector.
Default value
nullDetails- Type
- array
array $_signs = array()Subqueries signs.
If true then subquery is required.
If false then subquery is prohibited.
If null then subquery is neither prohibited, nor required
If array is null then all subqueries are required
Default valuearray()Details- Type
- array
array $_subqueries = array()Subqueries
Array of Zend_Search_Lucene_Search_Query
Default value
array()Details- Type
- array
Methods
__construct(array $subqueries = null, array $signs = null) : voidClass constructor. Create a new Boolean query object.
if $signs array is omitted then all subqueries are required
it differs from addSubquery() behavior, but should never be used
Parameters| Name | Type | Description |
|---|---|---|
| $subqueries | array | Array of Zend_Search_Search_Query objects |
| $signs | array | Array of signs. Sign is boolean|null. |
__toString() : stringPrint a query
Returns
| Type | Description |
|---|---|
| string |
_calculateConjunctionResult() : voidCalculate result vector for Conjunction query
(like '
_calculateNonConjunctionResult() : voidCalculate result vector for non Conjunction query
(like '
_conjunctionScore(integer $docId, \Zend_Search_Lucene_Interface $reader) : floatScore calculator for conjunction queries (all subqueries are required)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $docId | integer | |
| $reader | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| float |
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : voidQuery specific matches highlighting
Parameters
| Name | Type | Description |
|---|---|---|
| $highlighter | \Zend_Search_Lucene_Search_Highlighter_Interface | Highlighter object (also contains doc for highlighting) |
_nonConjunctionScore(integer $docId, \Zend_Search_Lucene_Interface $reader) : floatScore calculator for non conjunction queries (not all subqueries are required)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $docId | integer | |
| $reader | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| float |
addSubquery(\Zend_Search_Lucene_Search_Query $subquery, boolean | null $sign = null) : voidAdd a $subquery (Zend_Search_Lucene_Search_Query) to this query.
The sign is specified as:
TRUE - subquery is required
FALSE - subquery is prohibited
NULL - subquery is neither prohibited, nor required
Parameters| Name | Type | Description |
|---|---|---|
| $subquery | \Zend_Search_Lucene_Search_Query | |
| $sign | boolean | null |
createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_WeightConstructs an appropriate Weight implementation for this query.
Parameters
Returns
| 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
Parameters
| Name | Type | Description |
|---|---|---|
| $reader | \Zend_Search_Lucene_Interface | |
| $docsFilter | \Zend_Search_Lucene_Index_DocsFilter | null |
getQueryTerms() : arrayReturn query terms
Returns
| Type | Description |
|---|---|
| array |
getSigns() : arrayReturn subqueries signs
Returns
| Type | Description |
|---|---|
| array |
getSubqueries() : arrayReturns subqueries
Returns
| Type | Description |
|---|---|
| array |
matchedDocs() : arrayGet document ids likely matching the query
It's an array with document ids as keys (performance considerations)
Returns| Type | Description |
|---|---|
| array |
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_QueryOptimize query in the context of specified index
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $index | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Search_Query |
rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_QueryRe-write queries into primitive queries
Parameters
Returns
| 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
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $docId | integer | |
| $reader | \Zend_Search_Lucene_Interface |
| Type | Description |
|---|---|
| float |