Search/Lucene/Search/Query/Range.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Search_Query_Range

Table of Contents

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: Range.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Search_Lucene_Search_Query_Range
jump to top

Package: Zend\Search\Lucene\Search

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

inherited

query boost factor

Inherited from: \Zend_Search_Lucene_Search_Query::$$_boost

Default value1Details

Type: float
Inherited_from: \Zend_Search_Lucene_Search_Query::$$_boost

integer $_currentColorIndex = 0

inherited

Current highlight color

Inherited from: \Zend_Search_Lucene_Search_Query::$$_currentColorIndex

Default value0Details

Type: integer
Inherited_from: \Zend_Search_Lucene_Search_Query::$$_currentColorIndex

string $_field =

Search field

Details

Type: string

boolean $_inclusive =

Inclusive

Details

Type: boolean

\Zend_Search_Lucene_Index_Term $_lowerTerm =

Lower term.

Details

Type: \Zend_Search_Lucene_Index_Term

array $_matches = null

Matched terms.

Matched terms list. It's filled during the search (rewrite operation) and may be used for search result post-processing

Array of Zend_Search_Lucene_Index_Term objects

Default valuenullDetails

Type: array

\Zend_Search_Lucene_Index_Term $_upperTerm =

Upper term.

Details

Type: \Zend_Search_Lucene_Index_Term

\Zend_Search_Lucene_Search_Weight $_weight = null

inherited

Query weight

Inherited from: \Zend_Search_Lucene_Search_Query::$$_weight

Default valuenullDetails

Type: \Zend_Search_Lucene_Search_Weight
Inherited_from: \Zend_Search_Lucene_Search_Query::$$_weight

Methods

__construct(\Zend_Search_Lucene_Index_Term | null $lowerTerm, \Zend_Search_Lucene_Index_Term | null $upperTerm, boolean $inclusive) : void

Zend_Search_Lucene_Search_Query_Range constructor.

Parameters

Name	Type	Description
$lowerTerm	\Zend_Search_Lucene_Index_Term \| null
$upperTerm	\Zend_Search_Lucene_Index_Term \| null
$inclusive	boolean

Throws

Exception	Description
\Zend_Search_Lucene_Exception

__toString() : string

Print a query

Returns

Type	Description
string

_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : void

Query specific matches highlighting

Parameters

Name	Type	Description
$highlighter	\Zend_Search_Lucene_Search_Highlighter_Interface	Highlighter object (also contains doc for highlighting)

_initWeight(\Zend_Search_Lucene_Interface $reader) : void

inherited

Constructs an initializes a Weight for a _top-level_query_.

Inherited from: \Zend_Search_Lucene_Search_Query::_initWeight()

Parameters

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.

Parameters

Name	Type	Description
$reader	\Zend_Search_Lucene_Interface

Returns

Type	Description
\Zend_Search_Lucene_Search_Weight

Throws

Exception	Description
\Zend_Search_Lucene_Exception

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

Parameters

Name	Type	Description
$reader	\Zend_Search_Lucene_Interface
$docsFilter	\Zend_Search_Lucene_Index_DocsFilter \| null

Throws

Exception	Description
\Zend_Search_Lucene_Exception

getBoost() : float

inherited

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.

Returns

Type	Description
float

getField() : string | null

Get query field name

Returns

Type	Description
string \| null

getLowerTerm() : \Zend_Search_Lucene_Index_Term | null

Get lower term

Returns

Type	Description
\Zend_Search_Lucene_Index_Term \| null

getQueryTerms() : array

Return query terms

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Search_Lucene_Exception

getUpperTerm() : \Zend_Search_Lucene_Index_Term | null

Get upper term

Returns

Type	Description
\Zend_Search_Lucene_Index_Term \| null

highlightMatches(string $inputHTML, string $defaultEncoding = '', \Zend_Search_Lucene_Search_Highlighter_Interface | null $highlighter = null) : string

inherited

Highlight matches in $inputHTML

Inherited from: \Zend_Search_Lucene_Search_Query::highlightMatches()

Parameters

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

Returns

Type	Description
string

htmlFragmentHighlightMatches(string $inputHtmlFragment, string $encoding = 'UTF-8', \Zend_Search_Lucene_Search_Highlighter_Interface | null $highlighter = null) : string

inherited

Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)

Inherited from: \Zend_Search_Lucene_Search_Query::htmlFragmentHighlightMatches()

Parameters

Name	Type	Description
$inputHtmlFragment	string
$encoding	string	Input HTML string encoding
$highlighter	\Zend_Search_Lucene_Search_Highlighter_Interface \| null

Returns

Type	Description
string

isInclusive() : boolean

Get upper term

Returns

Type	Description
boolean

matchedDocs() : array

Get document ids likely matching the query

It's an array with document ids as keys (performance considerations)

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Search_Lucene_Exception

optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query

Optimize query in the context of specified index

Parameters

Name	Type	Description
$index	\Zend_Search_Lucene_Interface

Returns

Type	Description
\Zend_Search_Lucene_Search_Query

reset() : void

inherited

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

Parameters

Name	Type	Description
$index	\Zend_Search_Lucene_Interface

Returns

Type	Description
\Zend_Search_Lucene_Search_Query

score(integer $docId, \Zend_Search_Lucene_Interface $reader) : float

Score specified document

Parameters

Name	Type	Description
$docId	integer
$reader	\Zend_Search_Lucene_Interface

Returns

Type	Description
float

Throws

Exception	Description
\Zend_Search_Lucene_Exception

setBoost(float $boost) : void

inherited

Sets the boost for this query clause to $boost.

Inherited from: \Zend_Search_Lucene_Search_Query::setBoost()

Parameters

Name	Type	Description
$boost	float

Search/Lucene/Search/Query/Range.php

\Zend_Search_Lucene_Search_Query_Rangejump to top

Properties

Methods

\Zend_Search_Lucene_Search_Query_Range
jump to top