Search/Lucene/Search/Query/Phrase.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: Phrase.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Search_Lucene_Search_Query_Phrase

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_Phrase
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; $_offsets; $_slop; $_resVector; $_termsPositions
Methods: __construct; setSlop; getSlop; addTerm; rewrite; optimize; getTerms; setWeight; createWeight; _exactPhraseFreq; _sloppyPhraseFreq; execute; matchedDocs; score; getQueryTerms; _highlightMatches; __toString

Description

A Query that matches documents containing a particular sequence of terms.

Properties

$_offsets
jump to class

array $_offsets = ''

Term positions (relative positions of terms within the phrase).

Array of integers

Details

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

$_resVector
jump to class

array $_resVector = 'null'

Result vector.

Details

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

$_slop
jump to class

integer $_slop = ''

Sets the number of other words permitted between words in query phrase.

If zero, then this is an exact phrase search. For larger values this works like a WITHIN or NEAR operator.

The slop is in fact an edit-distance, where the units correspond to moves of terms in the query phrase out of position. For example, to switch the order of two words requires two moves (the first move places the words atop one another), so to permit re-orderings of phrases, the slop must be at least two. More exact matches are scored higher than sloppier matches, thus search results are sorted by exactness.

The slop is zero by default, requiring exact matches.

Details

$_slop: integer
visibility: private
default
final: false
static: false

$_terms
jump to class

array $_terms = ''

Terms to find.

Array of Zend_Search_Lucene_Index_Term objects.

Details

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

$_termsPositions
jump to class

array $_termsPositions = 'array'

Terms positions vectors.

Array of Arrays: term1Id => (docId => array( pos1, pos2, ... ), ...) term2Id => (docId => array( pos1, pos2, ... ), ...)

Details

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

Methods

__construct
jump to class

__construct(
          array $terms
              =
              null, array $offsets
              =
              null, string $field
              =
              null
          )
        
        :

Class constructor. Create a new prase query.

Arguments

$terms: array
Terms to search Array of strings.
$offsets: array
Relative term positions. Array of integers.
$field: string
Field to search.

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

_exactPhraseFreq
jump to class

_exactPhraseFreq(
          integer $docId
          )
        
        :
        float

Score calculator for exact phrase queries (terms sequence is fixed)

Arguments

$docId: integer

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

_sloppyPhraseFreq
jump to class

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

Score calculator for sloppy phrase queries (terms sequence is fixed)

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, integer $position
              =
              null
          )
        
        :

Adds a term to the end of the query phrase.

The relative position of the term is specified explicitly or the one immediately after the last term added.

Arguments

$term: Zend_Search_Lucene_Index_Term
$position: integer

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

getSlop
jump to class

getSlop(
          
          )
        
        :
        integer

Get slop

Output

integer

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

setSlop
jump to class

setSlop(
          integer $slop
          )
        
        :

Set slop

Arguments

$slop: integer

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/Phrase.php

Description

Zend_Search_Lucene_Search_Query_Phrasejump to top

Description

Properties

$_offsetsjump to class

Details

$_resVectorjump to class

Details

$_slopjump to class

Details

$_termsjump to class

Details

$_termsPositionsjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_exactPhraseFreqjump to class

Arguments

Output

Details

_highlightMatchesjump to class

Arguments

Details

_sloppyPhraseFreqjump 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

getSlopjump 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

setSlopjump to class

Arguments

Details

setWeightjump to class

Arguments

Details

Zend_Search_Lucene_Search_Query_Phrase
jump to top

$_offsets
jump to class

$_resVector
jump to class

$_slop
jump to class

$_terms
jump to class

$_termsPositions
jump to class

__construct
jump to class

__toString
jump to class

_exactPhraseFreq
jump to class

_highlightMatches
jump to class

_sloppyPhraseFreq
jump to class

addTerm
jump to class

createWeight
jump to class

execute
jump to class

getQueryTerms
jump to class

getSlop
jump to class

getTerms
jump to class

matchedDocs
jump to class

optimize
jump to class

rewrite
jump to class

score
jump to class

setSlop
jump to class

setWeight
jump to class