Search/Lucene/Search/Query/Range.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: Range.php 22988 2010-09-21 10:53:41Z alexander $
Classes: Zend_Search_Lucene_Search_Query_Range

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_Range
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: $_lowerTerm; $_upperTerm; $_field; $_inclusive; $_matches
Methods: __construct; getField; getLowerTerm; getUpperTerm; isInclusive; rewrite; optimize; getQueryTerms; createWeight; execute; matchedDocs; score; _highlightMatches; __toString

Description

Properties

$_field
jump to class

string $_field = ''

Search field

Details

$_field: string
visibility: private
default
final: false
static: false

$_inclusive
jump to class

boolean $_inclusive = ''

Inclusive

Details

$_inclusive: boolean
visibility: private
default
final: false
static: false

$_lowerTerm
jump to class

Zend_Search_Lucene_Index_Term $_lowerTerm = ''

Lower term.

Details

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

$_matches
jump to class

array $_matches = 'null'

Matched terms.

Matched terms list. It's filled during the search (rewrite operation) and may be used for search result post-processing

Array of Zend_Search_Lucene_Index_Term objects

Details

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

$_upperTerm
jump to class

Zend_Search_Lucene_Index_Term $_upperTerm = ''

Upper term.

Details

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

Methods

__construct
jump to class

__construct(
          Zend_Search_Lucene_Index_Term|null $lowerTerm, Zend_Search_Lucene_Index_Term|null $upperTerm, boolean $inclusive
          )
        
        :

Zend_Search_Lucene_Search_Query_Range constructor.

Arguments

$lowerTerm: Zend_Search_Lucene_Index_Termnull
$upperTerm: Zend_Search_Lucene_Index_Termnull
$inclusive: boolean

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

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

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
throws

getField
jump to class

getField(
          
          )
        
        :
        string|null

Get query field name

Output

string|null

Details

visibility: public
final: false
static: false

getLowerTerm
jump to class

getLowerTerm(
          
          )
        
        :
        Zend_Search_Lucene_Index_Term|null

Get lower term

Output

Zend_Search_Lucene_Index_Term|null

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
throws

getUpperTerm
jump to class

getUpperTerm(
          
          )
        
        :
        Zend_Search_Lucene_Index_Term|null

Get upper term

Output

Zend_Search_Lucene_Index_Term|null

Details

visibility: public
final: false
static: false

isInclusive
jump to class

isInclusive(
          
          )
        
        :
        boolean

Get upper term

Output

boolean

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
throws

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
throws

API Documentation

Search/Lucene/Search/Query/Range.php

Description

Zend_Search_Lucene_Search_Query_Rangejump to top

Description

Properties

$_fieldjump to class

Details

$_inclusivejump to class

Details

$_lowerTermjump to class

Details

$_matchesjump to class

Details

$_upperTermjump 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

getFieldjump to class

Output

Details

getLowerTermjump to class

Output

Details

getQueryTermsjump to class

Output

Details

getUpperTermjump to class

Output

Details

isInclusivejump 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_Range
jump to top

$_field
jump to class

$_inclusive
jump to class

$_lowerTerm
jump to class

$_matches
jump to class

$_upperTerm
jump to class

__construct
jump to class

__toString
jump to class

_highlightMatches
jump to class

createWeight
jump to class

execute
jump to class

getField
jump to class

getLowerTerm
jump to class

getQueryTerms
jump to class

getUpperTerm
jump to class

isInclusive
jump to class

matchedDocs
jump to class

optimize
jump to class

rewrite
jump to class

score
jump to class