Class Zend_Search_Lucene_Index_SegmentInfo

Description

Located in /Zend/Search/Lucene/Index/SegmentInfo.php (line 32)


	
			
Variable Summary
Method Summary
 Zend_Search_Lucene_Index_SegmentInfo __construct (string $name, integer $docCount, Zend_Search_Lucene_Storage_Directory $directory)
 integer count ()
 ZSearchFieldInfo getField (integer $fieldNum)
 integer getFieldNum (string $fieldName)
 array getFields ([boolean $indexed = false])
 string getName ()
 string norm (integer $id, string $fieldName)
 void _loadDictionary ()
Variables

File system adapter.

  • access: private
integer $_docCount (line 39)

Number of docs in a segment

  • access: private
array $_fields (line 70)

Segment fields. Array of Zend_Search_Lucene_Index_FieldInfo objects for this segment

  • access: private
array $_fieldsDicPositions (line 78)

Field positions in a dictionary.

(Term dictionary contains filelds ordered by names)

  • access: private
string $_name (line 46)

Segment name

  • access: private
array $_norms = array() (line 106)

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

  • access: private
array $_segFiles (line 87)

Associative array where the key is the file name and the value is data offset in a compound segment file (.csf).

  • access: private
array $_termDictionary (line 55)

Term Dictionary Index Array of the Zend_Search_Lucene_Index_Term objects Corresponding Zend_Search_Lucene_Index_TermInfo object stored in the $_termDictionaryInfos

  • access: private
array $_termDictionaryInfos (line 63)

Term Dictionary Index TermInfos Array of the Zend_Search_Lucene_Index_TermInfo objects

  • access: private
Methods
Constructor __construct (line 116)

Zend_Search_Lucene_Index_SegmentInfo constructor needs Segmentname, Documents count and Directory as a parameter.

  • access: public
Zend_Search_Lucene_Index_SegmentInfo __construct (string $name, integer $docCount, Zend_Search_Lucene_Storage_Directory $directory)
count (line 229)

Returns the total number of documents in this segment.

  • access: public
integer count ()
getField (line 201)

Returns field info for specified field

  • access: public
ZSearchFieldInfo getField (integer $fieldNum)
  • integer $fieldNum
getFieldNum (line 184)

Returns field index or -1 if field is not found

  • access: public
integer getFieldNum (string $fieldName)
  • string $fieldName
getFields (line 213)

Returns array of fields.

if $indexed parameter is true, then returns only indexed fields.

  • access: public
array getFields ([boolean $indexed = false])
  • boolean $indexed
getName (line 291)

Return segment name

  • access: public
string getName ()
getTermInfo (line 303)

Scans terms dictionary and returns term info

  • access: public
norm (line 396)

Returns normalization factor for specified documents

  • access: public
string norm (integer $id, string $fieldName)
  • integer $id
  • string $fieldName
openCompoundFile (line 164)

Opens index file stoted within compound index file

  • access: public
  • throws: Zend_Search_Lucene_Exception
Zend_Search_Lucene_Storage_File openCompoundFile (string $extension)
  • string $extension
_loadDictionary (line 238)

Loads Term dictionary from TermInfoIndex file

  • access: protected
void _loadDictionary ()

Documentation generated on Tue, 18 Apr 2006 11:55:34 -0700 by phpDocumentor 1.3.0RC3