API Documentation

Zend/Search/Lucene/Search/Weight.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: Weight.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Search_Lucene_Search_Weight

Package: Zend\Search\Lucene\Search

Calculate query weights and build query scorers.

A Weight is constructed by a query Query->createWeight(). The sumOfSquaredWeights() method is then called on the top-level query to compute the query normalization factor Similarity->queryNorm(float). This factor is then passed to normalize(float). At this point the weighting is complete.

Children
\Zend_Search_Lucene_Search_Weight_Empty
\Zend_Search_Lucene_Search_Weight_Phrase
\Zend_Search_Lucene_Search_Weight_Term
\Zend_Search_Lucene_Search_Weight_MultiTerm
\Zend_Search_Lucene_Search_Weight_Boolean
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedfloat  $_queryNorm= ''

Normalization factor.

This value is stored only for query expanation purpose and not used in any other place

Details
Type
float
Propertyprotectedfloat  $_value= ''

Weight value

Weight value may be initialized in sumOfSquaredWeights() or normalize() because they both are invoked either in Query::_initWeight (for top-level query) or in corresponding methods of parent query's weights

Details
Type
float

Methods

methodpublicgetValue( ) : float

The weight for this query.

Returns
Type Description
float
methodpublicnormalize( float $norm ) : void
abstract

Assigns the query normalization factor to this.

Parameters
Name Type Description
$norm float
methodpublicsumOfSquaredWeights( ) : float
abstract

The sum of squared weights of contained query clauses.

Returns
Type Description
float
Documentation was generated by DocBlox 0.15.1.