Docs For Class Zend_Search

Description

license: Zend Framework License version 1.0
copyright: Copyright (c) 2005-2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Search/Lucene.php (line 60)

Variable Summary

boolean $_closeDirOnExit

Zend_Search_Lucene_Storage_Directory $_directory

integer $_docCount

array $_segmentInfos

Zend_Search_Lucene_Index_Writer $_writer

Method Summary

Zend_Search_Lucene __construct ([mixed $directory = null], [mixed $create = false])

void __destruct ()

void addDocument (Zend_Search_Lucene_Document $document)

void commit ()

integer count ()

void delete (mixed $doc, mixed $item_to_del)

integer docFreq (Zend_Search_Lucene_Index_Term $term)

array find (mixed $query)

Zend_Search_Lucene_Storage_Directory getDirectory ()

Zend_Search_Lucene_Document getDocument (integer|Zend_Search_Lucene_Search_QueryHit $id)

array getFieldNames ([boolean $indexed = false])

Zend_Search_Lucene_Index_Writer getIndexWriter ()

Zend_Search_Lucene_Search_Similarity getSimilarity ()

boolean hasDeletions ()

Zend_Search_Lucene_Document norm (integer $id, string $fieldName)

array termDocs (Zend_Search_Lucene_Index_Term $term)

array termPositions (Zend_Search_Lucene_Index_Term $term)

array terms ()

void undeleteAll ()

Variables

boolean $_closeDirOnExit = true (line 74)

File system adapter closing option

access: private

Zend_Search_Lucene_Storage_Directory $_directory = null (line 67)

File system adapter.

access: private

integer $_docCount = 0 (line 95)

Number of documents in this index.

access: private

array $_segmentInfos = array() (line 88)

Array of Zend_Search_Lucene_Index_SegmentInfo objects for this index.

var: Zend_Search_Lucene_Index_SegmentInfo
access: private

Zend_Search_Lucene_Index_Writer $_writer = null (line 81)

Writer for this index, not instantiated unless required.

access: private

Methods

Constructor __construct (line 107)

Opens the index.

IndexReader constructor needs Directory as a parameter. It should be a string with a path to the index folder or a Directory object.

access: public
throws: Zend_Search_Lucene_Exception

Zend_Search_Lucene __construct ([mixed $directory = null], [mixed $create = false])

mixed $directory

Destructor __destruct (line 164)

Object destructor

access: public

void __destruct ()

addDocument (line 489)

Adds a document to this index.

access: public

void addDocument (Zend_Search_Lucene_Document $document)

Zend_Search_Lucene_Document $document

commit (line 504)

Commit changes resulting from delete() or undeleteAll() operations.

access: public
todo: delete() and undeleteAll processing.

void commit ()

count (line 204)

Returns the total number of documents in this index.

access: public

integer count ()

delete (line 558)

Deletes a document from the index. $doc may contain a Zend_Search_Lucene_Document or the number of the document to delete.

access: public
todo: Implementation

void delete (mixed $doc, mixed $item_to_del)

mixed $item_to_del

docFreq (line 434)

Returns the number of documents in this index containing the $term.

access: public

integer docFreq (Zend_Search_Lucene_Index_Term $term)

Zend_Search_Lucene_Index_Term $term

find (line 218)

Performs a query against the index and returns an array of Zend_Search_Lucene_Search_QueryHit objects.

Input is a string or Zend_Search_Lucene_Search_Query.

return: ZSearchHit
access: public

array find (mixed $query)

mixed $query

getDirectory (line 193)

Returns the Zend_Search_Lucene_Storage_Directory instance for this index.

access: public

Zend_Search_Lucene_Storage_Directory getDirectory ()

getDocument (line 274)

Returns a Zend_Search_Lucene_Document object for the document number $id in this index.

access: public

Zend_Search_Lucene_Document getDocument (integer|Zend_Search_Lucene_Search_QueryHit $id)

integer|Zend_Search_Lucene_Search_QueryHit $id

getFieldNames (line 257)

Returns a list of all unique field names that exist in this index.

access: public

array getFieldNames ([boolean $indexed = false])

boolean $indexed

getIndexWriter (line 178)

Returns an instance of Zend_Search_Lucene_Index_Writer for the index

access: public

Zend_Search_Lucene_Index_Writer getIndexWriter ()

getSimilarity (line 453)

Retrive similarity used by index reader

access: public

Zend_Search_Lucene_Search_Similarity getSimilarity ()

hasDeletions (line 545)

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

access: public
todo: Implementation

boolean hasDeletions ()

norm (line 466)

Returns a normalization factor for "field, document" pair.

access: public

Zend_Search_Lucene_Document norm (integer $id, string $fieldName)

integer $id
string $fieldName

termDocs (line 338)

Returns an array of all the documents which contain term.

access: public

array termDocs (Zend_Search_Lucene_Index_Term $term)

Zend_Search_Lucene_Index_Term $term

termPositions (line 380)

Returns an array of all term positions in the documents.

Return array structure: array( docId => array( pos1, pos2, ...), ...)

access: public

array termPositions (Zend_Search_Lucene_Index_Term $term)

Zend_Search_Lucene_Index_Term $term

terms (line 533)

Returns an array of all terms in this index.

access: public
todo: Implementation

array terms ()

undeleteAll (line 567)

Undeletes all documents currently marked as deleted in this index.

access: public
todo: Implementation

void undeleteAll ()