Search/Lucene/Search/Query/MultiTerm.php

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

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

Extends from: Zend_Search_Lucene_Search_Query
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: $_terms; $_signs; $_resVector; $_termsFreqs; $_coord; $_weights
Methods: __construct; addTerm; rewrite; optimize; getTerms; getSigns; setWeight; createWeight; _calculateConjunctionResult; _calculateNonConjunctionResult; _conjunctionScore; _nonConjunctionScore; execute; matchedDocs; score; getQueryTerms; _highlightMatches; __toString

Description

Properties

$_coord
jump to class

mixed $_coord = 'null'

A score factor based on the fraction of all query terms that a document contains.

float for conjunction queries array of float for non conjunction queries

Details

$_coord: mixed
visibility: private
default: null
final: false
static: false

$_resVector
jump to class

array $_resVector = 'null'

Result vector.

Details

$_resVector: array
visibility: private
default: null
final: false
static: false

$_signs
jump to class

array $_signs = ''

Term signs.

If true then term is required. If false then term is prohibited. If null then term is neither prohibited, nor required

If array is null then all terms are required

Details

$_signs: array
visibility: private
default
final: false
static: false

$_terms
jump to class

array $_terms = 'array'

Terms to find.

Array of Zend_Search_Lucene_Index_Term

Details

$_terms: array
visibility: private
default: array
final: false
static: false

$_termsFreqs
jump to class

array $_termsFreqs = 'array'

Terms positions vectors.

Array of Arrays: term1Id => (docId => freq, ...) term2Id => (docId => freq, ...)

Details

$_termsFreqs: array
visibility: private
default: array
final: false
static: false

$_weights
jump to class

array $_weights = 'array'

Terms weights array of Zend_Search_Lucene_Search_Weight

Details

$_weights: array
visibility: private
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $terms
              =
              null, array $signs
              =
              null
          )
        
        :

Class constructor. Create a new multi-term query object.

if $signs array is omitted then all terms are required it differs from addTerm() behavior, but should never be used

Arguments

$terms: array
Array of Zend_Search_Lucene_Index_Term objects
$signs: array
Array of signs. Sign is boolean|null.

Details

visibility: public
final: false
static: false
throws

__toString
jump to class

__toString(
          
          )
        
        :
        string

Print a query

Output

string

Details

visibility: public
final: false
static: false

_calculateConjunctionResult
jump to class

_calculateConjunctionResult(
          Zend_Search_Lucene_Interface $reader
          )
        
        :

Calculate result vector for Conjunction query (like '+something +another')

Arguments

$reader: Zend_Search_Lucene_Interface

Details

visibility: private
final: false
static: false

_calculateNonConjunctionResult
jump to class

_calculateNonConjunctionResult(
          Zend_Search_Lucene_Interface $reader
          )
        
        :

Calculate result vector for non Conjunction query (like '+something -another')

Arguments

$reader: Zend_Search_Lucene_Interface

Details

visibility: private
final: false
static: false

_conjunctionScore
jump to class

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

Score calculator for conjunction queries (all terms are required)

Arguments

$docId: integer
$reader: Zend_Search_Lucene_Interface

Output

float

Details

visibility: public
final: false
static: false

_highlightMatches
jump to class

_highlightMatches(
          Zend_Search_Lucene_Search_Highlighter_Interface $highlighter
          )
        
        :

Query specific matches highlighting

Arguments

$highlighter: Zend_Search_Lucene_Search_Highlighter_Interface
Highlighter object (also contains doc for highlighting)

Details

visibility: protected
final: false
static: false

_nonConjunctionScore
jump to class

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

Score calculator for non conjunction queries (not all terms are required)

Arguments

$docId: integer
$reader: Zend_Search_Lucene_Interface

Output

float

Details

visibility: public
final: false
static: false

addTerm
jump to class

addTerm(
          Zend_Search_Lucene_Index_Term $term, boolean|null $sign
              =
              null
          )
        
        :
        void

Add a $term (Zend_Search_Lucene_Index_Term) to this query.

The sign is specified as: TRUE - term is required FALSE - term is prohibited NULL - term is neither prohibited, nor required

Arguments

$term: Zend_Search_Lucene_Index_Term
$sign: booleannull

Details

visibility: public
final: false
static: false

createWeight
jump to class

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

Output

Zend_Search_Lucene_Search_Weight

Details

visibility: public
final: false
static: false

execute
jump to class

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
jump to class

getQueryTerms(
          
          )
        
        :
        array

Return query terms

Output

array

Details

visibility: public
final: false
static: false

getSigns
jump to class

getSigns(
          
          )
        
        :
        array

Return terms signs

Output

array

Details

visibility: public
final: false
static: false

getTerms
jump to class

getTerms(
          
          )
        
        :
        array

Returns query term

Output

array

Details

visibility: public
final: false
static: false

matchedDocs
jump to class

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
jump to class

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

Output

Zend_Search_Lucene_Search_Query

Details

visibility: public
final: false
static: false

rewrite
jump to class

rewrite(
          Zend_Search_Lucene_Interface $index
          )
        
        :
        Zend_Search_Lucene_Search_Query

Re-write query into primitive queries in the context of specified index

Arguments

$index: Zend_Search_Lucene_Interface

Output

Zend_Search_Lucene_Search_Query

Details

visibility: public
final: false
static: false

score
jump to class

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

setWeight
jump to class

setWeight(
          integer $num, Zend_Search_Lucene_Search_Weight_Term $weight
          )
        
        :

Set weight for specified term

Arguments

$num: integer
$weight: Zend_Search_Lucene_Search_Weight_Term

Details

visibility: public
final: false
static: false

API Documentation

Search/Lucene/Search/Query/MultiTerm.php

Description

Zend_Search_Lucene_Search_Query_MultiTermjump to top

Description

Properties

$_coordjump to class

Details

$_resVectorjump to class

Details

$_signsjump to class

Details

$_termsjump to class

Details

$_termsFreqsjump to class

Details

$_weightsjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_calculateConjunctionResultjump to class

Arguments

Details

_calculateNonConjunctionResultjump to class

Arguments

Details

_conjunctionScorejump to class

Arguments

Output

Details

_highlightMatchesjump to class

Arguments

Details

_nonConjunctionScorejump to class

Arguments

Output

Details

addTermjump to class

Arguments

Details

createWeightjump to class

Arguments

Output

Details

executejump to class

Arguments

Details

getQueryTermsjump to class

Output

Details

getSignsjump to class

Output

Details

getTermsjump to class

Output

Details

matchedDocsjump to class

Output

Details

optimizejump to class

Arguments

Output

Details

rewritejump to class

Arguments

Output

Details

scorejump to class

Arguments

Output

Details

setWeightjump to class

Arguments

Details

Zend_Search_Lucene_Search_Query_MultiTerm
jump to top

$_coord
jump to class

$_resVector
jump to class

$_signs
jump to class

$_terms
jump to class

$_termsFreqs
jump to class

$_weights
jump to class

__construct
jump to class

__toString
jump to class

_calculateConjunctionResult
jump to class

_calculateNonConjunctionResult
jump to class

_conjunctionScore
jump to class

_highlightMatches
jump to class

_nonConjunctionScore
jump to class

addTerm
jump to class

createWeight
jump to class

execute
jump to class

getQueryTerms
jump to class

getSigns
jump to class

getTerms
jump to class

matchedDocs
jump to class

optimize
jump to class

rewrite
jump to class

score
jump to class

setWeight
jump to class