API Documentation

Zend/Search/Lucene/Search/Query/Range.php

Show: inherited
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 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: Range.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Search_Lucene_Search_Query_Range

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

Propertyprivatestring  $_field= ''

Search field

Details
Type
string
Propertyprivateboolean  $_inclusive= ''

Inclusive

Details
Type
boolean
Propertyprivate\Zend_Search_Lucene_Index_Term  $_lowerTerm= ''

Lower term.

Propertyprivatearray  $_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
Propertyprivate\Zend_Search_Lucene_Index_Term  $_upperTerm= ''

Upper term.

Methods

methodpublic__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
methodpublic__toString( ) : string

Print a query

Returns
Type Description
string
methodprotected_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)

methodpubliccreateWeight( \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
methodpublicexecute( \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

Parameters
Name Type Description
$reader \Zend_Search_Lucene_Interface
$docsFilter \Zend_Search_Lucene_Index_DocsFilter|null
Throws
Exception Description
\Zend_Search_Lucene_Exception
methodpublicgetField( ) : string|null

Get query field name

Returns
Type Description
string|null
methodpublicgetLowerTerm( ) : \Zend_Search_Lucene_Index_Term|null

Get lower term

Returns
Type Description
\Zend_Search_Lucene_Index_Term|null
methodpublicgetQueryTerms( ) : array

Return query terms

Returns
Type Description
array
Throws
Exception Description
\Zend_Search_Lucene_Exception
methodpublicgetUpperTerm( ) : \Zend_Search_Lucene_Index_Term|null

Get upper term

Returns
Type Description
\Zend_Search_Lucene_Index_Term|null
methodpublicisInclusive( ) : boolean

Get upper term

Returns
Type Description
boolean
methodpublicmatchedDocs( ) : 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
methodpublicoptimize( \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
methodpublicrewrite( \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
methodpublicscore( 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
Documentation was generated by DocBlox 0.15.1.