Search/Lucene/Search/Query/Fuzzy.php

Show: PublicProtectedPrivateinherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Search_Lucene  
Subpackage
Search  
Version
$Id: Fuzzy.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Search_Lucene_Search_Query_Fuzzy

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

Constants

>VConstant  DEFAULT_MIN_SIMILARITY = 0.5
Default minimum similarity
>VConstant  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()

Properties

>VPropertyprivatefloat $_boost = 1
inherited
query boost factor
Inherited from: \Zend_Search_Lucene_Search_Query::$$_boost
Default value1Details
Type
float
Inherited_from
\Zend_Search_Lucene_Search_Query::$$_boost  
>VPropertyprivateinteger $_currentColorIndex = 0
inherited
Current highlight color
Inherited from: \Zend_Search_Lucene_Search_Query::$$_currentColorIndex
Default value0Details
Type
integer
Inherited_from
\Zend_Search_Lucene_Search_Query::$$_currentColorIndex  
>VPropertyprivateinteger $_defaultPrefixLength = 3
static
Default non-fuzzy prefix length
Default value3Details
Type
integer
>VPropertyprivatearray $_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

Default valuenullDetails
Type
array
>VPropertyprivate$_maxDistances = array()
Array of precalculated max distances

keys are integers representing a word size

Default valuearray()Details
Type
n/a
>VPropertyprivatefloat $_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
Type
float
>VPropertyprivateinteger $_prefixLength
The length of common (non-fuzzy) prefix
Details
Type
integer
>VPropertyprivatearray $_scores = null
Matched terms scores
Default valuenullDetails
Type
array
>VPropertyprivate\Zend_Search_Lucene_Index_Term $_term
Base searching term.
>VPropertyprivatearray $_termKeys = null
Array of the term keys.

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

Default valuenullDetails
Type
array
>VPropertyprotected\Zend_Search_Lucene_Search_Weight $_weight = null
inherited
Query weight
Inherited from: \Zend_Search_Lucene_Search_Query::$$_weight

Methods

methodpublic__construct(\Zend_Search_Lucene_Index_Term $term, float $minimumSimilarity = self::DEFAULT_MIN_SIMILARITY, integer $prefixLength = null) : void

Zend_Search_Lucene_Search_Query_Wildcard constructor.

Parameters
NameTypeDescription
$term\Zend_Search_Lucene_Index_Term
$minimumSimilarityfloat
$prefixLengthinteger
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublic__toString() : string

Print a query

Returns
TypeDescription
string
methodprivate_calculateMaxDistance(integer $prefixLength, integer $termLength, integer $length) : integer

Calculate maximum distance for specified word length

Parameters
NameTypeDescription
$prefixLengthinteger
$termLengthinteger
$lengthinteger
Returns
TypeDescription
integer
methodprotected_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : void

Query specific matches highlighting

Parameters
NameTypeDescription
$highlighter\Zend_Search_Lucene_Search_Highlighter_Interface

Highlighter object (also contains doc for highlighting)

methodprotected_initWeight(\Zend_Search_Lucene_Interface $reader) : void
inherited

Constructs an initializes a Weight for a _top-level_query_.

Inherited from: \Zend_Search_Lucene_Search_Query::_initWeight()
Parameters
NameTypeDescription
$reader\Zend_Search_Lucene_Interface
methodpubliccreateWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight

Constructs an appropriate Weight implementation for this query.

Parameters
NameTypeDescription
$reader\Zend_Search_Lucene_Interface
Returns
TypeDescription
\Zend_Search_Lucene_Search_Weight
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicexecute(\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

Query specific implementation

Parameters
NameTypeDescription
$reader\Zend_Search_Lucene_Interface
$docsFilter\Zend_Search_Lucene_Index_DocsFilter | null
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicgetBoost() : float
inherited

Gets the boost for this clause.

Inherited from: \Zend_Search_Lucene_Search_Query::getBoost()

Documents matching this clause will (in addition to the normal weightings) have their score multiplied by boost. The boost is 1.0 by default.

Returns
TypeDescription
float
methodpublicgetDefaultPrefixLength() : integer
static

Get default non-fuzzy prefix length

Returns
TypeDescription
integer
methodpublicgetQueryTerms() : array

Return query terms

Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublichighlightMatches(string $inputHTML, string $defaultEncoding = '', \Zend_Search_Lucene_Search_Highlighter_Interface | null $highlighter = null) : string
inherited

Highlight matches in $inputHTML

Inherited from: \Zend_Search_Lucene_Search_Query::highlightMatches()
Parameters
NameTypeDescription
$inputHTMLstring
$defaultEncodingstring

HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.

$highlighter\Zend_Search_Lucene_Search_Highlighter_Interface | null
Returns
TypeDescription
string
methodpublichtmlFragmentHighlightMatches(string $inputHtmlFragment, string $encoding = 'UTF-8', \Zend_Search_Lucene_Search_Highlighter_Interface | null $highlighter = null) : string
inherited

Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)

Inherited from: \Zend_Search_Lucene_Search_Query::htmlFragmentHighlightMatches()
Parameters
NameTypeDescription
$inputHtmlFragmentstring
$encodingstring

Input HTML string encoding

$highlighter\Zend_Search_Lucene_Search_Highlighter_Interface | null
Returns
TypeDescription
string
methodpublicmatchedDocs() : array

Get document ids likely matching the query

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

Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicoptimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query

Optimize query in the context of specified index

Parameters
NameTypeDescription
$index\Zend_Search_Lucene_Interface
Returns
TypeDescription
\Zend_Search_Lucene_Search_Query
methodpublicreset() : void
inherited

Reset query, so it can be reused within other queries or with other indeces

Inherited from: \Zend_Search_Lucene_Search_Query::reset()
methodpublicrewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query

Re-write query into primitive queries in the context of specified index

Parameters
NameTypeDescription
$index\Zend_Search_Lucene_Interface
Returns
TypeDescription
\Zend_Search_Lucene_Search_Query
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicscore(integer $docId, \Zend_Search_Lucene_Interface $reader) : float

Score specified document

Parameters
NameTypeDescription
$docIdinteger
$reader\Zend_Search_Lucene_Interface
Returns
TypeDescription
float
Throws
ExceptionDescription
\Zend_Search_Lucene_Exception
methodpublicsetBoost(float $boost) : void
inherited

Sets the boost for this query clause to $boost.

Inherited from: \Zend_Search_Lucene_Search_Query::setBoost()
Parameters
NameTypeDescription
$boostfloat
methodpublicsetDefaultPrefixLength(integer $defaultPrefixLength) : void
static

Set default non-fuzzy prefix length

Parameters
NameTypeDescription
$defaultPrefixLengthinteger
Documentation was generated by phpDocumentor 2.0.0a12.