category | Zend |
---|---|
package | Zend_Search_Lucene |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Search_Lucene_Index_TermsStream_Interface |
addDocument(\Zend_Search_Lucene_Document $document)
\Zend_Search_Lucene_Document
commit()
count() : integer
integer
delete(integer|\Zend_Search_Lucene_Search_QueryHit $id)
$id is an internal document id
integer
\Zend_Search_Lucene_Search_QueryHit
\Zend_Search_Lucene_Exception |
---|
docFreq(\Zend_Search_Lucene_Index_Term $term) : integer
\Zend_Search_Lucene_Index_Term
integer
find(mixed $query) : array
Input is a string or Zend_Search_Lucene_Search_Query.
mixed
\Zend_Search_Lucene_Exception |
---|
array
Zend_Search_Lucene_Search_QueryHitgetActualGeneration(\Zend_Search_Lucene_Storage_Directory $directory) : integer
Returns generation number 0 means pre-2.1 index format -1 means there are no segments files.
\Zend_Search_Lucene_Storage_Directory
\Zend_Search_Lucene_Exception |
---|
integer
getDefaultSearchField() : string
Null means, that search is performed through all fields by default
string
getDirectory() : \Zend_Search_Lucene_Storage_Directory
\Zend_Search_Lucene_Storage_Directory
getDocument(integer|\Zend_Search_Lucene_Search_QueryHit $id) : \Zend_Search_Lucene_Document
integer
\Zend_Search_Lucene_Search_QueryHit
\Zend_Search_Lucene_Document
getFieldNames(boolean $indexed = false
) : array
boolean
array
getFormatVersion() : integer
integer
getMaxBufferedDocs() : integer
maxBufferedDocs is a minimal number of documents required before the buffered in-memory documents are written into a new Segment
Default value is 10
integer
getMaxMergeDocs() : integer
maxMergeDocs is a largest number of documents ever merged by addDocument(). Small values (e.g., less than 10,000) are best for interactive indexing, as this limits the length of pauses while indexing to a few seconds. Larger values are best for batched indexing and speedier searches.
Default value is PHP_INT_MAX
integer
getMergeFactor() : integer
mergeFactor determines how often segment indices are merged by addDocument(). With smaller values, less RAM is used while indexing, and searches on unoptimized indices are faster, but indexing speed is slower. With larger values, more RAM is used during indexing, and while searches on unoptimized indices are slower, indexing is faster. Thus larger values (> 10) are best for batch index creation, and smaller values (< 10) for indices that are interactively maintained.
Default value is 10
integer
getResultSetLimit() : integer
0 means no limit
integer
getSegmentFileName(integer $generation) : string
integer
string
getSimilarity() : \Zend_Search_Lucene_Search_Similarity
\Zend_Search_Lucene_Search_Similarity
hasDeletions() : boolean
boolean
hasTerm(\Zend_Search_Lucene_Index_Term $term) : boolean
Is used for query optimization.
\Zend_Search_Lucene_Index_Term
boolean
isDeleted(integer $id) : boolean
integer
\Zend_Search_Lucene_Exception |
Exception is thrown if $id is out of the range |
---|
boolean
maxDoc() : integer
This may be used to, e.g., determine how big to allocate a structure which will have an element for every document number in an index.
integer
norm(integer $id, string $fieldName) : float
integer
string
float
numDocs() : integer
integer
optimize()
Merges all segments into one
setDefaultSearchField(string $fieldName)
Null means, that search is performed through all fields by default
Default value is null
string
setFormatVersion(integer $formatVersion)
Index is converted to this format at the nearest upfdate time
integer
\Zend_Search_Lucene_Exception |
---|
setMaxBufferedDocs(integer $maxBufferedDocs)
maxBufferedDocs is a minimal number of documents required before the buffered in-memory documents are written into a new Segment
Default value is 10
integer
setMaxMergeDocs(integer $maxMergeDocs)
maxMergeDocs is a largest number of documents ever merged by addDocument(). Small values (e.g., less than 10,000) are best for interactive indexing, as this limits the length of pauses while indexing to a few seconds. Larger values are best for batched indexing and speedier searches.
Default value is PHP_INT_MAX
integer
setMergeFactor($mergeFactor)
mergeFactor determines how often segment indices are merged by addDocument(). With smaller values, less RAM is used while indexing, and searches on unoptimized indices are faster, but indexing speed is slower. With larger values, more RAM is used during indexing, and while searches on unoptimized indices are slower, indexing is faster. Thus larger values (> 10) are best for batch index creation, and smaller values (< 10) for indices that are interactively maintained.
Default value is 10
setResultSetLimit(integer $limit)
0 (default) means no limit
integer
termDocs(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null
) : array
\Zend_Search_Lucene_Index_Term
\Zend_Search_Lucene_Index_DocsFilter
null
array
termDocsFilter(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null
) : \Zend_Search_Lucene_Index_DocsFilter
It performs the same operation as termDocs, but return result as Zend_Search_Lucene_Index_DocsFilter object
\Zend_Search_Lucene_Index_Term
\Zend_Search_Lucene_Index_DocsFilter
null
\Zend_Search_Lucene_Index_DocsFilter
termFreqs(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null
) : integer
Return array structure: array( docId => freq, ...)
\Zend_Search_Lucene_Index_Term
\Zend_Search_Lucene_Index_DocsFilter
null
integer
termPositions(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null
) : array
Return array structure: array( docId => array( pos1, pos2, ...), ...)
\Zend_Search_Lucene_Index_Term
\Zend_Search_Lucene_Index_DocsFilter
null
array
terms() : array
array
undeleteAll()