Search/Lucene/Search/Query/MultiTerm.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Search_Query_MultiTerm

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Search_Lucene
Subpackage: Search
Version: $Id$

\Zend_Search_Lucene_Search_Query_MultiTerm
jump to top

Package: Zend_Search_Lucene\Search

Parent(s): \Zend_Search_Lucene_Search_Query
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

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

Default valuenullDetails

Type: mixed

array $_resVector = null

Result vector.

Default valuenullDetails

Type: array

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

Type: array

array $_terms = array()

Terms to find.

Array of Zend_Search_Lucene_Index_Term

Default valuearray()Details

Type: array

array $_termsFreqs = array()

Terms positions vectors.

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

Default valuearray()Details

Type: array

array $_weights = array()

Terms weights array of Zend_Search_Lucene_Search_Weight

Default valuearray()Details

Type: array

Methods

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

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

Parameters

Name	Type	Description
$terms	array	Array of Zend_Search_Lucene_Index_Term objects
$signs	array	Array of signs. Sign is boolean\|null.

Throws

Exception	Description
\Zend_Search_Lucene_Exception

__toString() : string

Print a query

Returns

Type	Description
string

_calculateConjunctionResult(\Zend_Search_Lucene_Interface $reader) : void

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

Parameters

Name	Type	Description
$reader	\Zend_Search_Lucene_Interface

_calculateNonConjunctionResult(\Zend_Search_Lucene_Interface $reader) : void

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

Parameters

Name	Type	Description
$reader	\Zend_Search_Lucene_Interface

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

Score calculator for conjunction queries (all terms are required)

Parameters

Name	Type	Description
$docId	integer
$reader	\Zend_Search_Lucene_Interface

Returns

Type	Description
float

_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)

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

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

Parameters

Name	Type	Description
$docId	integer
$reader	\Zend_Search_Lucene_Interface

Returns

Type	Description
float

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

Parameters

Name	Type	Description
$term	\Zend_Search_Lucene_Index_Term
$sign	boolean \| null

createWeight(\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

execute(\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

getQueryTerms() : array

Return query terms

Returns

Type	Description
array

getSigns() : array

Return terms signs

Returns

Type	Description
array

getTerms() : array

Returns query term

Returns

Type	Description
array

matchedDocs() : array

Get document ids likely matching the query

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

Returns

Type	Description
array

optimize(\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

rewrite(\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

score(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

setWeight(integer $num, \Zend_Search_Lucene_Search_Weight_Term $weight) : void

Set weight for specified term

Parameters

Name	Type	Description
$num	integer
$weight	\Zend_Search_Lucene_Search_Weight_Term

Search/Lucene/Search/Query/MultiTerm.php

\Zend_Search_Lucene_Search_Query_MultiTermjump to top

Properties

Methods

\Zend_Search_Lucene_Search_Query_MultiTerm
jump to top