Search/Lucene/Index/SegmentWriter/StreamWriter.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: StreamWriter.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Index_SegmentWriter_StreamWriter
- Parent(s)
- \Zend_Search_Lucene_Index_SegmentWriter
- 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 = integer $_docCount = 0Number of docs in a segment
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_docCount0Details- Type
- integer
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_docCount
\Zend_Search_Lucene_Storage_File $_fdtFile = null'.fdt' file - Stored Fields, the field data.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_fdtFilenullDetails- Type
- \Zend_Search_Lucene_Storage_File
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_fdtFile
\Zend_Search_Lucene_Storage_File $_fdxFile = null'.fdx' file - Stored Fields, the field index.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_fdxFilenullDetails- Type
- \Zend_Search_Lucene_Storage_File
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_fdxFile
array $_fields = array()
Array of Zend_Search_Lucene_Index_FieldInfo objects for this segment
array()Details- Type
- array
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_fields
\unknown_type $_files = array()
Used for automatic compound file generation
array()Details- Type
- \unknown_type
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_files
\Zend_Search_Lucene_Storage_File $_frqFile = null
nullDetails- Type
- \Zend_Search_Lucene_Storage_File
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_frqFile
integer $_lastIndexPosition = Last term dictionary file position
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_lastIndexPosition- Type
- integer
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_lastIndexPosition
array $_norms = 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())
array()Details- Type
- array
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_norms
\Zend_Search_Lucene_Index_Term $_prevIndexTerm = Last saved index term
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_prevIndexTerm\Zend_Search_Lucene_Index_TermInfo $_prevIndexTermInfo = Last saved index term info
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_prevIndexTermInfo\Zend_Search_Lucene_Index_Term $_prevTerm =
- Type
- \Zend_Search_Lucene_Index_Term
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_prevTerm
\Zend_Search_Lucene_Index_TermInfo $_prevTermInfo = Last saved term info
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_prevTermInfo\Zend_Search_Lucene_Storage_File $_prxFile = null
nullDetails- Type
- \Zend_Search_Lucene_Storage_File
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_prxFile
integer $_termCount = Number of written terms
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_termCount- Type
- integer
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_termCount
\Zend_Search_Lucene_Storage_File $_tiiFile = nullTerm Dictionary index file
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$_tiiFilenullDetails- Type
- \Zend_Search_Lucene_Storage_File
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_tiiFile
\Zend_Search_Lucene_Storage_File $_tisFile = null
nullDetails- Type
- \Zend_Search_Lucene_Storage_File
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$_tisFile
integer $indexInterval = 128Expert: The fraction of terms in the "dictionary" which should be stored in RAM.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$indexIntervalSmaller 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
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$indexInterval
integer $maxSkipLevels = 0Expert: The maximum number of skip levels.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$maxSkipLevelsSmaller 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
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$maxSkipLevels
integer $skipInterval = 2147483647Expert: The fraction of TermDocs entries stored in skip tables.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::$$skipIntervalLarger 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
- Inherited_from
- \Zend_Search_Lucene_Index_SegmentWriter::$$skipInterval
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
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::_dumpFNM()_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.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::_dumpTermDictEntry()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
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::_generateCFS()addField(\Zend_Search_Lucene_Field $field) : integerAdd field to the segment
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::addField()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
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::addFieldInfo()Returns actual field number
| Name | Type | Description |
|---|---|---|
| $fieldInfo | \Zend_Search_Lucene_Index_FieldInfo |
| Type | Description |
|---|---|
| integer |
addNorm( $fieldName, $normVector) : void| Name | Type | Description |
|---|---|---|
| $fieldName | ||
| $normVector |
addStoredFields(array $storedFields) : voidAdd stored fields information
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::addStoredFields()| Name | Type | Description |
|---|---|---|
| $storedFields | array | array of Zend_Search_Lucene_Field objects |
addTerm(\Zend_Search_Lucene_Index_Term $termEntry, array $termDocs) : void
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
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::closeDictionaryFiles()count() : integerReturns the total number of documents in this segment.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::count()| Type | Description |
|---|---|
| integer |
createStoredFieldsFiles() : voidCreate stored fields files and open them for write
getFieldInfos() : arrayReturns array of FieldInfo objects.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::getFieldInfos()| Type | Description |
|---|---|
| array |
getName() : string
| Type | Description |
|---|---|
| string |
initializeDictionaryFiles() : voidCreate dicrionary, frequency and positions files and write necessary headers
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::initializeDictionaryFiles()