[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/search/Zend/Search/Lucene/Index/ -> SegmentInfo.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
File Size: 1056 lines (31 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 1 class

Zend_Search_Lucene_Index_SegmentInfo:: (27 methods):
  __construct()
  openCompoundFile()
  compoundFileLength()
  getFieldNum()
  getField()
  getFields()
  getFieldInfos()
  count()
  _deletedCount()
  numDocs()
  _getFieldPosition()
  getName()
  _cleanUpTermInfoCache()
  getTermInfo()
  termFreqs()
  termPositions()
  _loadNorm()
  norm()
  normVector()
  hasDeletions()
  delete()
  isDeleted()
  writeChanges()
  reset()
  nextTerm()
  currentTerm()
  currentTermPositions()


Class: Zend_Search_Lucene_Index_SegmentInfo  - X-Ref


__construct($name, $docCount, $directory)   X-Ref
Zend_Search_Lucene_Index_SegmentInfo constructor needs Segmentname,
Documents count and Directory as a parameter.

param: string $name
param: integer $docCount
param: Zend_Search_Lucene_Storage_Directory $directory

openCompoundFile($extension, $shareHandler = true)   X-Ref
Opens index file stoted within compound index file

param: string $extension
param: boolean $shareHandler
return: Zend_Search_Lucene_Storage_File

compoundFileLength($extension)   X-Ref
Get compound file length

param: string $extension
return: integer

getFieldNum($fieldName)   X-Ref
Returns field index or -1 if field is not found

param: string $fieldName
return: integer

getField($fieldNum)   X-Ref
Returns field info for specified field

param: integer $fieldNum
return: Zend_Search_Lucene_Index_FieldInfo

getFields($indexed = false)   X-Ref
Returns array of fields.
if $indexed parameter is true, then returns only indexed fields.

param: boolean $indexed
return: array

getFieldInfos()   X-Ref
Returns array of FieldInfo objects.

return: array

count()   X-Ref
Returns the total number of documents in this segment (including deleted documents).

return: integer

_deletedCount()   X-Ref
Returns number of deleted documents.

return: integer

numDocs()   X-Ref
Returns the total number of non-deleted documents in this segment.

return: integer

_getFieldPosition($fieldNum)   X-Ref
Get field position in a fields dictionary

param: integer $fieldNum
return: integer

getName()   X-Ref
Return segment name

return: string

_cleanUpTermInfoCache()   X-Ref
TermInfo cache

Size is 1024.
Numbers are used instead of class constants because of performance considerations


getTermInfo(Zend_Search_Lucene_Index_Term $term)   X-Ref
Scans terms dictionary and returns term info

param: Zend_Search_Lucene_Index_Term $term
return: Zend_Search_Lucene_Index_TermInfo

termFreqs(Zend_Search_Lucene_Index_Term $term, $shift = 0)   X-Ref
Returns term freqs array.
Result array structure: array(docId => freq, ...)

param: Zend_Search_Lucene_Index_Term $term
param: integer $shift
return: Zend_Search_Lucene_Index_TermInfo

termPositions(Zend_Search_Lucene_Index_Term $term, $shift = 0)   X-Ref
Returns term positions array.
Result array structure: array(docId => array(pos1, pos2, ...), ...)

param: Zend_Search_Lucene_Index_Term $term
param: integer $shift
return: Zend_Search_Lucene_Index_TermInfo

_loadNorm($fieldNum)   X-Ref
Load normalizatin factors from an index file

param: integer $fieldNum

norm($id, $fieldName)   X-Ref
Returns normalization factor for specified documents

param: integer $id
param: string $fieldName
return: float

normVector($fieldName)   X-Ref
Returns norm vector, encoded in a byte string

param: string $fieldName
return: string

hasDeletions()   X-Ref
Returns true if any documents have been deleted from this index segment.

return: boolean

delete($id)   X-Ref
Deletes a document from the index segment.
$id is an internal document id

param: integer

isDeleted($id)   X-Ref
Checks, that document is deleted

param: integer
return: boolean

writeChanges()   X-Ref
Write changes if it's necessary.


reset($startId = 0, $compact = false)   X-Ref
Reset terms stream

$startId - id for the fist document
$compact - remove deleted documents

Returns start document id for the next segment

param: integer $startId
param: boolean $compact
return: integer

nextTerm()   X-Ref
Scans terms dictionary and returns next term

return: Zend_Search_Lucene_Index_Term|null

currentTerm()   X-Ref
Returns term in current position

param: Zend_Search_Lucene_Index_Term $term
return: Zend_Search_Lucene_Index_Term|null

currentTermPositions()   X-Ref
Returns an array of all term positions in the documents.
Return array structure: array( docId => array( pos1, pos2, ...), ...)

return: array



Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7