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
inherited_from \Zend_Search_Lucene_Index_SegmentWriter

 Methods

Object constructor.

__construct(\Zend_Search_Lucene_Storage_Directory $directory, string $name) 
inherited_from \Zend_Search_Lucene_Index_SegmentWriter::__construct()

Parameters

$directory

\Zend_Search_Lucene_Storage_Directory

$name

string

Object constructor.

__construct(\Zend_Search_Lucene_Storage_Directory $directory, string $name) 
Inherited

Parameters

$directory

\Zend_Search_Lucene_Storage_Directory

$name

string

Add field to the segment

addField(\Zend_Search_Lucene_Field $field) : integer
Inherited

Returns actual field number

Parameters

$field

\Zend_Search_Lucene_Field

Returns

integer

Add fieldInfo to the segment

addFieldInfo(\Zend_Search_Lucene_Index_FieldInfo $fieldInfo) : integer
Inherited

Returns actual field number

Parameters

$fieldInfo

\Zend_Search_Lucene_Index_FieldInfo

Returns

integer

addNorm()

addNorm($fieldName, $normVector) 

Parameters

$fieldName

$normVector

Add stored fields information

addStoredFields(array $storedFields) 
Inherited

Parameters

$storedFields

array

array of Zend_Search_Lucene_Field objects

Add term

addTerm(\Zend_Search_Lucene_Index_Term $termEntry, array $termDocs) 
Inherited

Term positions is an array( docId => array(pos1, pos2, pos3, ...), ... )

Parameters

$termEntry

\Zend_Search_Lucene_Index_Term

$termDocs

array

Close segment, write it to disk and return segment info

close() : \Zend_Search_Lucene_Index_SegmentInfo
inherited_from \Zend_Search_Lucene_Index_SegmentWriter::close()

Returns

\Zend_Search_Lucene_Index_SegmentInfo

Close segment, write it to disk and return segment info

close() : \Zend_Search_Lucene_Index_SegmentInfo
Inherited

Returns

\Zend_Search_Lucene_Index_SegmentInfo

Close dictionary

closeDictionaryFiles() 
Inherited

Returns the total number of documents in this segment.

count() : integer
Inherited

Returns

integer

Create stored fields files and open them for write

createStoredFieldsFiles() 

Returns array of FieldInfo objects.

getFieldInfos() : array
Inherited

Returns

array

Return segment name

getName() : string
Inherited

Returns

string

Create dicrionary, frequency and positions files and write necessary headers

initializeDictionaryFiles() 
Inherited

Dump Field Info (.fnm) segment file

_dumpFNM() 
Inherited

Dump Term Dictionary segment file entry.

_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) 
Inherited

Used to write entry to .tis or .tii files

Parameters

$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

Generate compound index file

_generateCFS() 
Inherited

 Properties

 

Expert: 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.

$indexInterval : integer

Default

128
Static
 

Expert: The maximum number of skip levels. Smaller values result in slightly smaller indexes, but slower skipping in big posting lists.

$maxSkipLevels : integer

Default

0
Static

0 indicates that we don't use skip data

Note: not used in current implementation

 

Expert: The fraction of TermDocs entries stored in skip tables.

$skipInterval : integer

Default

2147483647
Static

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

 

File system adapter.

$_directory : \Zend_Search_Lucene_Storage_Directory

Default

 

Number of docs in a segment

$_docCount : integer

Default

0
 

'.fdt' file - Stored Fields, the field data.

$_fdtFile : \Zend_Search_Lucene_Storage_File

Default

null
 

'.fdx' file - Stored Fields, the field index.

$_fdxFile : \Zend_Search_Lucene_Storage_File

Default

null
 

Segment fields. Array of Zend_Search_Lucene_Index_FieldInfo objects for this segment

$_fields : array

Default

array()
 

List of the index files.

$_files : \unknown_type

Default

array()

Used for automatic compound file generation

 

Segment name

$_name : string

Default

 

Normalization factors.

$_norms : array

Default

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())

 

Frequencies file

$_frqFile : \Zend_Search_Lucene_Storage_File

Default

null
 

Last term dictionary file position

$_lastIndexPosition : integer

Default

 

Last saved index term

$_prevIndexTerm : \Zend_Search_Lucene_Index_Term

Default

 

Last saved index term info

$_prevIndexTermInfo : \Zend_Search_Lucene_Index_TermInfo

Default

 

Last saved term

$_prevTerm : \Zend_Search_Lucene_Index_Term

Default

 

Last saved term info

$_prevTermInfo : \Zend_Search_Lucene_Index_TermInfo

Default

 

Positions file

$_prxFile : \Zend_Search_Lucene_Storage_File

Default

null
 

Number of written terms

$_termCount : integer

Default

 

Term Dictionary index file

$_tiiFile : \Zend_Search_Lucene_Storage_File

Default

null
 

Term Dictionary file

$_tisFile : \Zend_Search_Lucene_Storage_File

Default

null