| category |
Zend |
| package |
Zend_Search_Lucene |
| subpackage |
Search |
| copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license |
New BSD License |
| inherited_from |
\Zend_Search_Lucene_Search_Query |
Methods
Zend_Search_Lucene_Search_Query_Wildcard constructor.
__construct(\Zend_Search_Lucene_Index_Term $term, float $minimumSimilarity = self::DEFAULT_MIN_SIMILARITY, integer $prefixLength = null)
Parameters
$term
\Zend_Search_Lucene_Index_Term
$minimumSimilarity
float
$prefixLength
integer
Exceptions
\Zend_Search_Lucene_Exception |
|
Print a query
__toString() : string
| inherited_from |
\Zend_Search_Lucene_Search_Query::__toString() |
Returns
string
Print a query
__toString() : string
Inherited
Constructs an appropriate Weight implementation for this query.
createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight
| inherited_from |
\Zend_Search_Lucene_Search_Query::createWeight() |
Parameters
$reader
\Zend_Search_Lucene_Interface
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
\Zend_Search_Lucene_Search_Weight
Constructs an appropriate Weight implementation for this query.
createWeight(\Zend_Search_Lucene_Interface $reader) : \Zend_Search_Lucene_Search_Weight
Inherited
Parameters
$reader
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Weight
Execute query in context of index reader
It also initializes necessary internal structures
execute(\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null)
Query specific implementation
| inherited_from |
\Zend_Search_Lucene_Search_Query::execute() |
Parameters
$reader
\Zend_Search_Lucene_Interface
$docsFilter
\Zend_Search_Lucene_Index_DocsFilternull
Exceptions
\Zend_Search_Lucene_Exception |
|
Execute query in context of index reader
It also initializes necessary internal structures
execute(\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null)
Inherited
Query specific implementation
Parameters
$reader
\Zend_Search_Lucene_Interface
$docsFilter
\Zend_Search_Lucene_Index_DocsFilternull
Gets the boost for this clause. Documents matching
this clause will (in addition to the normal weightings) have their score
multiplied by boost. The boost is 1.0 by default.
getBoost() : float
Inherited
Get default non-fuzzy prefix length
getDefaultPrefixLength() : integer
Static
Return query terms
getQueryTerms() : array
| inherited_from |
\Zend_Search_Lucene_Search_Query::getQueryTerms() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
array
Return query terms
getQueryTerms() : array
Inherited
Highlight matches in $inputHTML
highlightMatches(string $inputHTML, string $defaultEncoding = '', \Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null) : string
Inherited
Parameters
$inputHTML
string
$defaultEncoding
stringHTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
$highlighter
\Zend_Search_Lucene_Search_Highlighter_Interfacenull
Returns
string
Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)
htmlFragmentHighlightMatches(string $inputHtmlFragment, string $encoding = 'UTF-8', \Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null) : string
Inherited
Parameters
$inputHtmlFragment
string
$encoding
stringInput HTML string encoding
$highlighter
\Zend_Search_Lucene_Search_Highlighter_Interfacenull
Returns
string
Get document ids likely matching the query
matchedDocs() : array
It's an array with document ids as keys (performance considerations)
| inherited_from |
\Zend_Search_Lucene_Search_Query::matchedDocs() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
array
Get document ids likely matching the query
matchedDocs() : array
Inherited
It's an array with document ids as keys (performance considerations)
Returns
array
Optimize query in the context of specified index
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
| inherited_from |
\Zend_Search_Lucene_Search_Query::optimize() |
Parameters
$index
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Query
Optimize query in the context of specified index
optimize(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
Inherited
Parameters
$index
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Query
Reset query, so it can be reused within other queries or
with other indeces
reset()
Inherited
Re-write query into primitive queries in the context of specified index
rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
| inherited_from |
\Zend_Search_Lucene_Search_Query::rewrite() |
Parameters
$index
\Zend_Search_Lucene_Interface
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
\Zend_Search_Lucene_Search_Query
Re-write query into primitive queries in the context of specified index
rewrite(\Zend_Search_Lucene_Interface $index) : \Zend_Search_Lucene_Search_Query
Inherited
Parameters
$index
\Zend_Search_Lucene_Interface
Returns
\Zend_Search_Lucene_Search_Query
Score specified document
score(integer $docId, \Zend_Search_Lucene_Interface $reader) : float
| inherited_from |
\Zend_Search_Lucene_Search_Query::score() |
Parameters
$docId
integer
$reader
\Zend_Search_Lucene_Interface
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
float
Score specified document
score(integer $docId, \Zend_Search_Lucene_Interface $reader) : float
Inherited
Parameters
$docId
integer
$reader
\Zend_Search_Lucene_Interface
Returns
float
Sets the boost for this query clause to $boost.
setBoost(float $boost)
Inherited
Set default non-fuzzy prefix length
setDefaultPrefixLength(integer $defaultPrefixLength)
Static
Parameters
$defaultPrefixLength
integer
Query specific matches highlighting
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
| inherited_from |
\Zend_Search_Lucene_Search_Query::_highlightMatches() |
Parameters
$highlighter
\Zend_Search_Lucene_Search_Highlighter_InterfaceHighlighter object (also contains doc for highlighting)
Query specific matches highlighting
_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
Inherited
Parameters
$highlighter
\Zend_Search_Lucene_Search_Highlighter_InterfaceHighlighter object (also contains doc for highlighting)
Constructs an initializes a Weight for a _top-level_query_.
_initWeight(\Zend_Search_Lucene_Interface $reader)
Inherited
Parameters
$reader
\Zend_Search_Lucene_Interface
Calculate maximum distance for specified word length
_calculateMaxDistance(integer $prefixLength, integer $termLength, integer $length) : integer
Parameters
$prefixLength
integer
$termLength
integer
$length
integer
Returns
integer
Properties
Query weight
$_weight : \Zend_Search_Lucene_Search_Weight
query boost factor
$_boost : float
Current highlight color
$_currentColorIndex : integer
Default non-fuzzy prefix length
$_defaultPrefixLength : integer
Static
Matched terms.
$_matches : array
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
Array of precalculated max distances
$_maxDistances
keys are integers representing a word size
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
$_minimumSimilarity : float
The length of common (non-fuzzy) prefix
$_prefixLength : integer
Matched terms scores
$_scores : array
Base searching term.
$_term : \Zend_Search_Lucene_Index_Term
Array of the term keys.
$_termKeys : array
Used to sort terms in alphabetical order if terms have the same socres
Constants
Default minimum similarity
DEFAULT_MIN_SIMILARITY = 0.5
Maximum number of matched terms.
MAX_CLAUSE_COUNT = 1024
Apache Lucene defines this limitation as boolean query maximum number of clauses:
org.apache.lucene.search.BooleanQuery.getMaxClauseCount()