API Documentation

Search/Lucene/Search/Weight.php

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: Weight.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Search_Lucene_Search_Weight

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_Weight
jump to top

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
Properties
$_queryNorm
$_value
Methods
getValue
sumOfSquaredWeights
normalize

Description

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.

Properties

$_queryNorm
jump to class

float $_queryNorm = ''

Normalization factor.

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

Details

$_queryNorm
float
visibility
protected
default
final
false
static
false

$_value
jump to class

float $_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

$_value
float
visibility
protected
default
final
false
static
false

Methods

getValue
jump to class

getValue( ) : float

The weight for this query.

Output
float
Details
visibility
public
final
false
static
false

normalize
jump to class

normalize(  $norm ) :

Assigns the query normalization factor to this.

Arguments
$norm
Details
visibility
public
final
false
static
false

sumOfSquaredWeights
jump to class

sumOfSquaredWeights( ) : float

The sum of squared weights of contained query clauses.

Output
float
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.