API Documentation

Search/Lucene/Search/Query/Preprocessing.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Search
version
$Id: Preprocessing.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Search_Lucene_Search_Query_Preprocessing

Description

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.

Zend_Search_Lucene_Search_Query_Preprocessing

Extends from
Zend_Search_Lucene_Search_Query
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
internal
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Search
Properties
$_matches
Methods
optimize
createWeight
execute
matchedDocs
score
getQueryTerms

Description

It's an internal abstract class intended to finalize ase a query processing after query parsing.

This type of query is not actually involved into query execution.

Properties

$_matches

array $_matches = 'null'

Matched terms.

Matched terms list. It's filled during rewrite operation and may be used for search result highlighting

Array of Zend_Search_Lucene_Index_Term objects

Details

$_matches
array
visibility
protected
default
null
final
false
static
false

Methods

createWeight

createWeight( Zend_Search_Lucene_Interface $reader ) : Zend_Search_Lucene_Search_Weight

Constructs an appropriate Weight implementation for this query.

Arguments
$reader
Zend_Search_Lucene_Interface
Details
visibility
public
final
false
static
false

execute

execute( Zend_Search_Lucene_Interface $reader, Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null ) :

Execute query in context of index reader It also initializes necessary internal structures

Arguments
$reader
Zend_Search_Lucene_Interface
$docsFilter
Zend_Search_Lucene_Index_DocsFilternull
Details
visibility
public
final
false
static
false

getQueryTerms

getQueryTerms( ) : array

Return query terms

Output
array
Details
visibility
public
final
false
static
false

matchedDocs

matchedDocs( ) : array

Get document ids likely matching the query

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

Output
array
Details
visibility
public
final
false
static
false

optimize

optimize( Zend_Search_Lucene_Interface $index ) : Zend_Search_Lucene_Search_Query

Optimize query in the context of specified index

Arguments
$index
Zend_Search_Lucene_Interface
Details
visibility
public
final
false
static
false

score

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

Score specified document

Arguments
$docId
integer
$reader
Zend_Search_Lucene_Interface
Output
float
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.