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

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_Fuzzy
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
Constants: DEFAULT_MIN_SIMILARITY; MAX_CLAUSE_COUNT
Properties: $_maxDistances; $_term; $_minimumSimilarity; $_prefixLength; $_matches; $_scores; $_termKeys; $_defaultPrefixLength
Methods: __construct; getDefaultPrefixLength; setDefaultPrefixLength; _calculateMaxDistance; rewrite; optimize; getQueryTerms; createWeight; execute; matchedDocs; score; _highlightMatches; __toString

Description

Constants

DEFAULT_MIN_SIMILARITY
jump to class

 DEFAULT_MIN_SIMILARITY = '0.5'

Default minimum similarity

Details

value: 0.5

MAX_CLAUSE_COUNT
jump to class

 MAX_CLAUSE_COUNT = '1024'

Maximum number of matched terms.

Apache Lucene defines this limitation as boolean query maximum number of clauses: org.apache.lucene.search.BooleanQuery.getMaxClauseCount()

Details

value: 1024

Properties

$_defaultPrefixLength
jump to class

integer $_defaultPrefixLength = '3'

Default non-fuzzy prefix length

Details

$_defaultPrefixLength: integer
visibility: private
default: 3
final: false
static: true

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

$_maxDistances
jump to class

$_maxDistances = 'array'

Array of precalculated max distances

keys are integers representing a word size

Details

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

$_minimumSimilarity
jump to class

float $_minimumSimilarity = ''

A value between 0 and 1 to set the required similarity between the query term and the matching terms. For example, for a _minimumSimilarity of 0.5 a term of the same length as the query term is considered similar to the query term if the edit distance between both terms is less than length(term)*0.5

Details

$_minimumSimilarity: float
visibility: private
default
final: false
static: false

$_prefixLength
jump to class

integer $_prefixLength = ''

The length of common (non-fuzzy) prefix

Details

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

$_scores
jump to class

array $_scores = 'null'

Matched terms scores

Details

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

$_term
jump to class

Zend_Search_Lucene_Index_Term $_term = ''

Base searching term.

Details

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

$_termKeys
jump to class

array $_termKeys = 'null'

Array of the term keys.

Used to sort terms in alphabetical order if terms have the same socres

Details

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

Methods

__construct
jump to class

__construct(
          Zend_Search_Lucene_Index_Term $term, float $minimumSimilarity
              =
              self, integer $prefixLength
              =
              null
          )
        
        :

Zend_Search_Lucene_Search_Query_Wildcard constructor.

Arguments

$term: Zend_Search_Lucene_Index_Term
$minimumSimilarity: float
$prefixLength: integer

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

_calculateMaxDistance
jump to class

_calculateMaxDistance(
          integer $prefixLength, integer $termLength, integer $length
          )
        
        :
        integer

Calculate maximum distance for specified word length

Arguments

$prefixLength: integer
$termLength: integer
$length: integer

Output

integer

Details

visibility: private
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

getDefaultPrefixLength
jump to class

getDefaultPrefixLength(
          
          )
        
        :
        integer

Get default non-fuzzy prefix length

Output

integer

Details

visibility: public
final: false
static: true

getQueryTerms
jump to class

getQueryTerms(
          
          )
        
        :
        array

Return query terms

Output

array

Details

visibility: public
final: false
static: false
throws

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
throws

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

setDefaultPrefixLength
jump to class

setDefaultPrefixLength(
          integer $defaultPrefixLength
          )
        
        :

Set default non-fuzzy prefix length

Arguments

$defaultPrefixLength: integer

Details

visibility: public
final: false
static: true

API Documentation

Search/Lucene/Search/Query/Fuzzy.php

Description

Zend_Search_Lucene_Search_Query_Fuzzyjump to top

Description

Constants

DEFAULT_MIN_SIMILARITYjump to class

Details

MAX_CLAUSE_COUNTjump to class

Details

Properties

$_defaultPrefixLengthjump to class

Details

$_matchesjump to class

Details

$_maxDistancesjump to class

Details

$_minimumSimilarityjump to class

Details

$_prefixLengthjump to class

Details

$_scoresjump to class

Details

$_termjump to class

Details

$_termKeysjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_calculateMaxDistancejump to class

Arguments

Output

Details

_highlightMatchesjump to class

Arguments

Details

createWeightjump to class

Arguments

Output

Details

executejump to class

Arguments

Details

getDefaultPrefixLengthjump to class

Output

Details

getQueryTermsjump 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

setDefaultPrefixLengthjump to class

Arguments

Details

Zend_Search_Lucene_Search_Query_Fuzzy
jump to top

DEFAULT_MIN_SIMILARITY
jump to class

MAX_CLAUSE_COUNT
jump to class

$_defaultPrefixLength
jump to class

$_matches
jump to class

$_maxDistances
jump to class

$_minimumSimilarity
jump to class

$_prefixLength
jump to class

$_scores
jump to class

$_term
jump to class

$_termKeys
jump to class

__construct
jump to class

__toString
jump to class

_calculateMaxDistance
jump to class

_highlightMatches
jump to class

createWeight
jump to class

execute
jump to class

getDefaultPrefixLength
jump to class

getQueryTerms
jump to class

matchedDocs
jump to class

optimize
jump to class

rewrite
jump to class

score
jump to class

setDefaultPrefixLength
jump to class