Class Zend_Search_Lucene_Index_SegmentInfo

Description
  • license: New BSD License
  • copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)

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


	
			
Method Summary
 Zend_Search_Lucene_Index_SegmentInfo __construct (string $name, integer $docCount, Zend_Search_Lucene_Storage_Directory $directory)
 integer count ()
 void delete (mixed $id)
 ZSearchFieldInfo getField (integer $fieldNum)
 integer getFieldNum (string $fieldName)
 array getFields ([boolean $indexed = false])
 string getName ()
 boolean hasDeletions ()
 boolean isDeleted (mixed $id)
 string norm (integer $id, string $fieldName)
 void writeChanges ()
 void _loadDictionary ()
Methods
Constructor __construct (line 133)

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

Returns the total number of documents in this segment.

  • access: public
integer count ()
delete (line 501)

Deletes a document from the index segment.

$id is an internal document id

  • access: public
void delete (mixed $id)
getField (line 260)

Returns field info for specified field

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

Returns field index or -1 if field is not found

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

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

Return segment name

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

Scans terms dictionary and returns term info

  • access: public
hasDeletions (line 489)

Returns true if any documents have been deleted from this index segment.

  • access: public
boolean hasDeletions ()
isDeleted (line 525)

Checks, that document is deleted

  • access: public
boolean isDeleted (mixed $id)
norm (line 467)

Returns normalization factor for specified documents

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

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
writeChanges (line 542)

Write changes if it's necessary.

  • access: public
void writeChanges ()
_loadDictionary (line 308)

Loads Term dictionary from TermInfoIndex file

  • access: protected
void _loadDictionary ()

Documentation generated on Fri, 30 Jun 2006 11:21:35 -0500 by phpDocumentor 1.3.0RC6