Search/Lucene/Index/SegmentWriter.php
inherited
Classes
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 [email protected] 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
- Index
- Version
- $Id: SegmentWriter.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Index_SegmentWriter
- Children
- \Zend_Search_Lucene_Index_SegmentWriter_DocumentWriter
- \Zend_Search_Lucene_Index_SegmentWriter_StreamWriter
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\Zend_Search_Lucene_Storage_Directory $_directory = File system adapter.
integer $_docCount = 0Number of docs in a segment
0Details- Type
- integer
\Zend_Search_Lucene_Storage_File $_fdtFile = null'.fdt' file - Stored Fields, the field data.
nullDetails
\Zend_Search_Lucene_Storage_File $_fdxFile = null'.fdx' file - Stored Fields, the field index.
nullDetails
array $_fields = array()Segment fields.
Array of Zend_Search_Lucene_Index_FieldInfo objects for this segment
array()Details- Type
- array
\unknown_type $_files = array()List of the index files.
Used for automatic compound file generation
array()Details- Type
- \unknown_type
\Zend_Search_Lucene_Storage_File $_frqFile = nullFrequencies file
nullDetails
integer $_lastIndexPosition = Last term dictionary file position
- Type
- integer
string $_name = Segment name
- Type
- string
array $_norms = array()Normalization factors.
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())
array()Details- Type
- array
\Zend_Search_Lucene_Index_Term $_prevIndexTerm = Last saved index term
\Zend_Search_Lucene_Index_TermInfo $_prevIndexTermInfo = Last saved index term info
\Zend_Search_Lucene_Index_Term $_prevTerm = Last saved term
\Zend_Search_Lucene_Index_TermInfo $_prevTermInfo = Last saved term info
\Zend_Search_Lucene_Storage_File $_prxFile = nullPositions file
nullDetails
integer $_termCount = Number of written terms
- Type
- integer
\Zend_Search_Lucene_Storage_File $_tiiFile = nullTerm Dictionary index file
nullDetails
\Zend_Search_Lucene_Storage_File $_tisFile = nullTerm Dictionary file
nullDetails
integer $indexInterval = 128Expert: The fraction of terms in the "dictionary" which should be stored in RAM.
Smaller values use more memory, but make searching slightly faster, while larger values use less memory and make searching slightly slower. Searching is typically not dominated by dictionary lookup, so tweaking this is rarely useful.
128Details- Type
- integer
integer $maxSkipLevels = 0Expert: The maximum number of skip levels.
Smaller values result in slightly smaller indexes, but slower skipping in big posting lists.
0 indicates that we don't use skip data
Note: not used in current implementation
0Details- Type
- integer
integer $skipInterval = 2147483647Expert: The fraction of TermDocs entries stored in skip tables.
Larger values result in smaller indexes, greater acceleration, but fewer accelerable cases, while smaller values result in bigger indexes, less acceleration and more accelerable cases. More detailed experiments would be useful here.
0x7FFFFFFF indicates that we don't use skip data
Note: not used in current implementation
2147483647Details- Type
- integer
Methods
__construct(\Zend_Search_Lucene_Storage_Directory $directory, string $name) : voidObject constructor.
| Name | Type | Description |
|---|---|---|
| $directory | \Zend_Search_Lucene_Storage_Directory | |
| $name | string |
_dumpFNM() : voidDump Field Info (.fnm) segment file
_dumpTermDictEntry(\Zend_Search_Lucene_Storage_File $dicFile, \Zend_Search_Lucene_Index_Term $prevTerm, \Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_TermInfo $prevTermInfo, \Zend_Search_Lucene_Index_TermInfo $termInfo) : voidDump Term Dictionary segment file entry.
Used to write entry to .tis or .tii files
| Name | Type | Description |
|---|---|---|
| $dicFile | \Zend_Search_Lucene_Storage_File | |
| $prevTerm | \Zend_Search_Lucene_Index_Term | |
| $term | \Zend_Search_Lucene_Index_Term | |
| $prevTermInfo | \Zend_Search_Lucene_Index_TermInfo | |
| $termInfo | \Zend_Search_Lucene_Index_TermInfo |
_generateCFS() : voidGenerate compound index file
addField(\Zend_Search_Lucene_Field $field) : integerAdd field to the segment
Returns actual field number
| Name | Type | Description |
|---|---|---|
| $field | \Zend_Search_Lucene_Field |
| Type | Description |
|---|---|
| integer |
addFieldInfo(\Zend_Search_Lucene_Index_FieldInfo $fieldInfo) : integerAdd fieldInfo to the segment
Returns actual field number
| Name | Type | Description |
|---|---|---|
| $fieldInfo | \Zend_Search_Lucene_Index_FieldInfo |
| Type | Description |
|---|---|
| integer |
addStoredFields(array $storedFields) : voidAdd stored fields information
| Name | Type | Description |
|---|---|---|
| $storedFields | array | array of Zend_Search_Lucene_Field objects |
addTerm(\Zend_Search_Lucene_Index_Term $termEntry, array $termDocs) : voidAdd term
Term positions is an array( docId => array(pos1, pos2, pos3, ...), ... )
| Name | Type | Description |
|---|---|---|
| $termEntry | \Zend_Search_Lucene_Index_Term | |
| $termDocs | array |
close() : \Zend_Search_Lucene_Index_SegmentInfoClose segment, write it to disk and return segment info
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Index_SegmentInfo |
closeDictionaryFiles() : voidClose dictionary
count() : integerReturns the total number of documents in this segment.
| Type | Description |
|---|---|
| integer |
getFieldInfos() : arrayReturns array of FieldInfo objects.
| Type | Description |
|---|---|
| array |
getName() : stringReturn segment name
| Type | Description |
|---|---|
| string |
initializeDictionaryFiles() : voidCreate dicrionary, frequency and positions files and write necessary headers