category | Zend |
---|---|
package | Zend_Search_Lucene |
subpackage | Index |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
__construct(\Zend_Search_Lucene_Storage_Directory $directory, string $name, integer $docCount, integer $delGen= 0
, array|null $docStoreOptions= null
, boolean $hasSingleNormFile= false
, boolean $isCompound= null
)
\Zend_Search_Lucene_Storage_Directory
string
integer
integer
array
null
boolean
boolean
closeTermsStream()
Should be used for resources clean up if stream is not read up to the end
inherited_from | \Zend_Search_Lucene_Index_TermsStream_Interface::closeTermsStream() |
---|
compoundFileLength(string $extension) : integer
string
integer
count() : integer
integer
currentTerm() : \Zend_Search_Lucene_Index_Term | null
inherited_from | \Zend_Search_Lucene_Index_TermsStream_Interface::currentTerm() |
---|
\Zend_Search_Lucene_Index_Term
null
currentTermPositions() : array
Return array structure: array( docId => array( pos1, pos2, ...), ...)
array
delete($id)
$id is an internal document id
getDelGen() : integer
integer
getField(integer $fieldNum) : \Zend_Search_Lucene_Index_FieldInfo
integer
\Zend_Search_Lucene_Index_FieldInfo
getFieldInfos() : array
array
getFieldNum(string $fieldName) : integer
string
integer
getFields(boolean $indexed = false
) : array
if $indexed parameter is true, then returns only indexed fields.
boolean
array
getName() : string
string
getTermInfo(\Zend_Search_Lucene_Index_Term $term) : \Zend_Search_Lucene_Index_TermInfo
\Zend_Search_Lucene_Index_Term
\Zend_Search_Lucene_Index_TermInfo
hasDeletions() : boolean
boolean
hasSingleNormFile() : boolean
boolean
isCompound() : boolean
boolean
isDeleted($id) : boolean
boolean
nextTerm() : \Zend_Search_Lucene_Index_Term | null
inherited_from | \Zend_Search_Lucene_Index_TermsStream_Interface::nextTerm() |
---|
\Zend_Search_Lucene_Index_Term
null
norm(integer $id, string $fieldName) : float
integer
string
float
normVector(string $fieldName) : string
string
string
numDocs() : integer
integer
openCompoundFile(string $extension, boolean $shareHandler = true
) : \Zend_Search_Lucene_Storage_File
string
boolean
\Zend_Search_Lucene_Exception |
---|
\Zend_Search_Lucene_Storage_File
resetTermsStream() : integer
$startId - id for the fist document $compact - remove deleted documents
Returns start document id for the next segment
inherited_from | \Zend_Search_Lucene_Index_TermsStream_Interface::resetTermsStream() |
---|
\Zend_Search_Lucene_Exception |
---|
integer
skipTo(\Zend_Search_Lucene_Index_Term $prefix)
Prefix contains fully specified field info and portion of searched term
inherited_from | \Zend_Search_Lucene_Index_TermsStream_Interface::skipTo() |
---|
\Zend_Search_Lucene_Index_Term
\Zend_Search_Lucene_Exception |
---|
termDocs(\Zend_Search_Lucene_Index_Term $term, integer $shift= 0
, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter= null
) : array
\Zend_Search_Lucene_Index_Term
integer
\Zend_Search_Lucene_Index_DocsFilter
null
array
termFreqs(\Zend_Search_Lucene_Index_Term $term, integer $shift= 0
, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter= null
) : \Zend_Search_Lucene_Index_TermInfo
Result array structure: array(docId => freq, ...)
\Zend_Search_Lucene_Index_Term
integer
\Zend_Search_Lucene_Index_DocsFilter
null
\Zend_Search_Lucene_Index_TermInfo
termPositions(\Zend_Search_Lucene_Index_Term $term, integer $shift= 0
, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter= null
) : \Zend_Search_Lucene_Index_TermInfo
Result array structure: array(docId => array(pos1, pos2, ...), ...)
\Zend_Search_Lucene_Index_Term
integer
\Zend_Search_Lucene_Index_DocsFilter
null
\Zend_Search_Lucene_Index_TermInfo
_cleanUpTermInfoCache()
_deletedCount() : integer
integer
_detectLatestDelGen() : integer
Is actualy used from writeChanges() method or from the constructor if it's invoked from Index writer. In both cases index write lock is already obtained, so we shouldn't care about it
integer
_getFieldPosition(integer $fieldNum) : integer
integer
integer
_load21DelFile() : mixed
Returns bitset or an array depending on bitset extension availability
mixed
_loadDelFile() : mixed
Returns bitset or an array depending on bitset extension availability
\Zend_Search_Lucene_Exception |
---|
mixed
_loadDictionaryIndex()
\Zend_Search_Lucene_Exception |
---|
_loadNorm(integer $fieldNum)
integer
\Zend_Search_Lucene_Exception |
---|
_loadPre21DelFile() : mixed
Returns bitset or an array depending on bitset extension availability
\Zend_Search_Lucene_Exception |
---|
mixed
$_delGen : integer
-2 means autodetect latest delete generation -1 means 'there is no delete file' 0 means pre-2.1 format delete file X specifies used delete file
$_deleted : mixed
null
bitset if bitset extension is loaded or array otherwise.
$_deletedDirty : boolean
false
$_directory : \Zend_Search_Lucene_Storage_Directory_Filesystem
$_docCount : integer
$_docMap : array | null
null
It's not very effective from memory usage point of view, but much more faster, then other methods
$_fields : array
$_fieldsDicPositions : array
(Term dictionary contains filelds ordered by names)
$_frqFile : \Zend_Search_Lucene_Storage_File
null
$_frqFileOffset : integer
$_hasSingleNormFile : boolean
If true then one .nrm file is used for all fields Otherwise .fN files are used
$_indexInterval : integer
$_isCompound : boolean
$_lastTerm : \Zend_Search_Lucene_Index_Term
null
$_lastTermInfo : \Zend_Search_Lucene_Index_TermInfo
null
$_lastTermPositions : array | null
Array structure: array( docId => array( pos1, pos2, ...), ...)
Is set to null if term positions loading has to be skipped
$_name : string
$_norms : array
array()
An array fieldName => normVector normVector is a binary string. Each byte corresponds to an indexed document in a segment and encodes normalization factor (float value, encoded by Zend_Search_Lucene_Search_Similarity::encodeNorm())
$_prxFile : \Zend_Search_Lucene_Storage_File
null
$_prxFileOffset : integer
$_segFileSizes : array
$_segFiles : array
$_sharedDocStoreOptions
$_skipInterval : integer
$_termCount : integer
0
$_termDictionary : array
Array of arrays (Zend_Search_Lucene_Index_Term objects are represented as arrays because of performance considerations) [0] -> $termValue [1] -> $termFieldNum
Corresponding Zend_Search_Lucene_Index_TermInfo object stored in the $_termDictionaryInfos
$_termDictionaryInfos : array
Array of arrays (Zend_Search_Lucene_Index_TermInfo objects are represented as arrays because of performance considerations) [0] -> $docFreq [1] -> $freqPointer [2] -> $proxPointer [3] -> $skipOffset [4] -> $indexPointer
$_termInfoCache : array
array()
Size is 1024. Numbers are used instead of class constants because of performance considerations
$_termNum : integer
0
$_termsScanMode : integer
Values:
self::SM_TERMS_ONLY - terms are scanned, no additional info is retrieved self::SM_FULL_INFO - terms are scanned, frequency and position info is retrieved self::SM_MERGE_INFO - terms are scanned, frequency and position info is retrieved document numbers are compacted (shifted if segment has deleted documents)
$_tisFile : \Zend_Search_Lucene_Storage_File
null
$_tisFileOffset : integer
$_usesSharedDocStore : boolean
FULL_SCAN_VS_FETCH_BOUNDARY = 5
If filter selectivity is less than this value, then full scan is performed (since term entries fetching has some additional overhead).
SM_FULL_INFO = 1
SM_MERGE_INFO = 2
SM_TERMS_ONLY = 0