Zend_Search_Lucene_Index_SegmentWriter Class Reference

Public Member Functions
	__construct (Zend_Search_Lucene_Storage_Directory $directory, $name)
	Object constructor.
	addField (Zend_Search_Lucene_Field $field)
	Add field to the segment.
	addFieldInfo (Zend_Search_Lucene_Index_FieldInfo $fieldInfo)
	Add fieldInfo to the segment.
	getFieldInfos ()
	Returns array of FieldInfo objects.
	addStoredFields ($storedFields)
	Add stored fields information.
	count ()
	Returns the total number of documents in this segment.
	getName ()
	Return segment name.
	initializeDictionaryFiles ()
	Create dicrionary, frequency and positions files and write necessary headers.
	addTerm ($termEntry, $termDocs)
	Add term.
	closeDictionaryFiles ()
	Close dictionary.
	close ()
	Close segment, write it to disk and return segment info.

Static Public Attributes
static	$indexInterval = 128
static	$skipInterval = 0x7FFFFFFF
static	$maxSkipLevels = 0

Protected Member Functions
	_dumpFNM ()
	Dump Field Info (.fnm) segment file.
	_dumpTermDictEntry (Zend_Search_Lucene_Storage_File $dicFile, &$prevTerm, Zend_Search_Lucene_Index_Term $term, &$prevTermInfo, Zend_Search_Lucene_Index_TermInfo $termInfo)
	Dump Term Dictionary segment file entry.
	_generateCFS ()
	Generate compound index file.

Protected Attributes
	$_docCount = 0
	$_name
	$_directory
	$_files = array()
	$_fields = array()
	$_norms = array()
	$_fdxFile = null
	$_fdtFile = null

Constructor & Destructor Documentation

__construct	(	Zend_Search_Lucene_Storage_Directory	$directory,
			$name
	)

Object constructor.

Parameters

Zend_Search_Lucene_Storage_Directory	$directory
string	$name

Member Function Documentation

_dumpFNM ( )

protected

Dump Field Info (.fnm) segment file.

_dumpTermDictEntry ( Zend_Search_Lucene_Storage_File  $dicFile, &  $prevTerm, Zend_Search_Lucene_Index_Term  $term, &  $prevTermInfo, Zend_Search_Lucene_Index_TermInfo  $termInfo  )

protected

Dump Term Dictionary segment file entry.

Used to write entry to .tis or .tii files

Parameters

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

_generateCFS ( )

protected

Generate compound index file.

addField

(

Zend_Search_Lucene_Field

$field

)

Add field to the segment.

Returns actual field number

Parameters

Zend_Search_Lucene_Field

$field

Returns

integer

addFieldInfo

(

Zend_Search_Lucene_Index_FieldInfo

$fieldInfo

)

Add fieldInfo to the segment.

Returns actual field number

Parameters

Zend_Search_Lucene_Index_FieldInfo

$fieldInfo

Returns

integer

addStoredFields

(

$storedFields

)

Add stored fields information.

Parameters

array

$storedFields

array of Zend_Search_Lucene_Field objects

addTerm	(		$termEntry,
			$termDocs
	)

Add term.

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

Parameters

Zend_Search_Lucene_Index_Term	$termEntry
array	$termDocs

Todo:

Write Skip Data to a freq file. It's not used now, but make index more optimal

close ( )

abstract

Close segment, write it to disk and return segment info.

Returns

Zend_Search_Lucene_Index_SegmentInfo

closeDictionaryFiles

(

)

Close dictionary.

count

(

)

Returns the total number of documents in this segment.

Returns

integer

getFieldInfos

(

)

Returns array of FieldInfo objects.

Returns

array

getName

(

)

Return segment name.

Returns

string

initializeDictionaryFiles

(

)

Create dicrionary, frequency and positions files and write necessary headers.

Dump dictionary header

Member Data Documentation

$_directory

protected

$_docCount = 0

protected

$_fdtFile = null

protected

$_fdxFile = null

protected

$_fields = array()

protected

$_files = array()

protected

$_name

protected

$_norms = array()

protected

$indexInterval = 128

static

$maxSkipLevels = 0

static

$skipInterval = 0x7FFFFFFF

static