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

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_Term
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: $_term; $_docVector; $_termFreqs
Methods: __construct; rewrite; optimize; createWeight; execute; matchedDocs; score; getQueryTerms; getTerm; _highlightMatches; __toString

Description

Properties

$_docVector
jump to class

array $_docVector = 'null'

Documents vector.

Details

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

$_term
jump to class

Zend_Search_Lucene_Index_Term $_term = ''

Term to find.

Details

$_term: Zend_Search_Lucene_Index_Term
visibility: private
default
final: false
static: false

$_termFreqs
jump to class

array $_termFreqs = ''

Term freqs vector.

array(docId => freq, ...)

Details

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

Methods

__construct
jump to class

__construct(
          Zend_Search_Lucene_Index_Term $term
          )
        
        :

Zend_Search_Lucene_Search_Query_Term constructor

Arguments

$term: Zend_Search_Lucene_Index_Term

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

Print a query

Output

string

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

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

getTerm
jump to class

getTerm(
          
          )
        
        :
        Zend_Search_Lucene_Index_Term

Return query term

Output

Zend_Search_Lucene_Index_Term

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

API Documentation

Search/Lucene/Search/Query/Term.php

Description

Zend_Search_Lucene_Search_Query_Termjump to top

Description

Properties

$_docVectorjump to class

Details

$_termjump to class

Details

$_termFreqsjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_highlightMatchesjump to class

Arguments

Details

createWeightjump to class

Arguments

Output

Details

executejump to class

Arguments

Details

getQueryTermsjump to class

Output

Details

getTermjump 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

Zend_Search_Lucene_Search_Query_Term
jump to top

$_docVector
jump to class

$_term
jump to class

$_termFreqs
jump to class

__construct
jump to class

__toString
jump to class

_highlightMatches
jump to class

createWeight
jump to class

execute
jump to class

getQueryTerms
jump to class

getTerm
jump to class

matchedDocs
jump to class

optimize
jump to class

rewrite
jump to class

score
jump to class