Class Zend_Search_Lucene

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

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


	
			
Method Summary
 static string getDefaultSearchField ()
 static void setDefaultSearchField (string $fieldName)
 Zend_Search_Lucene __construct ([mixed $directory = null], [ $create = false])
 void __destruct ()
 void commit ()
 integer count ()
 array find (mixed $query)
 array getFieldNames ([boolean $indexed = false])
 integer getMaxBufferedDocs ()
 integer getMaxMergeDocs ()
 integer getMergeFactor ()
 boolean hasDeletions ()
 float norm (integer $id, string $fieldName)
 void optimize ()
 void setMaxBufferedDocs (integer $maxBufferedDocs)
 void setMaxMergeDocs (integer $maxMergeDocs)
 void setMergeFactor ( $mergeFactor, integer $maxMergeDocs)
 array terms ()
 void undeleteAll ()
Methods
static getDefaultSearchField (line 270)

Get default search field.

Null means, that search is performed through all fields by default

  • access: public
static string getDefaultSearchField ()
static setDefaultSearchField (line 258)

Set default search field.

Null means, that search is performed through all fields by default

Default value is null

  • access: public
static void setDefaultSearchField (string $fieldName)
  • string $fieldName
Constructor __construct (line 135)

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], [ $create = false])
  • mixed $directory
  • $create
Destructor __destruct (line 200)

Object destructor

  • access: public
void __destruct ()
addDocument (line 800)

Adds a document to this index.

  • access: public
void addDocument (Zend_Search_Lucene_Document $document)
commit (line 823)

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

  • access: public
  • todo: undeleteAll processing.
void commit ()
count (line 243)

Returns the total number of documents in this index.

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

Deletes a document from the index.

$id is an internal document id

  • access: public
  • throws: Zend_Search_Lucene_Exception
void delete (integer|Zend_Search_Lucene_Search_QueryHit $id)
docFreq (line 691)

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

  • access: public
integer docFreq (Zend_Search_Lucene_Index_Term $term)
find (line 392)

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: Zend_Search_Lucene_Search_QueryHit
  • access: public
  • throws: Zend_Search_Lucene_Exception
array find (mixed $query)
  • mixed $query
getDirectory (line 232)

Returns the Zend_Search_Lucene_Storage_Directory instance for this index.

  • access: public
getDocument (line 530)

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

  • access: public
getFieldNames (line 513)

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

  • access: public
array getFieldNames ([boolean $indexed = false])
  • boolean $indexed
getIndexWriter (line 217)

Returns an instance of Zend_Search_Lucene_Index_Writer for the index

  • access: public
getMaxBufferedDocs (line 285)

Retrieve index maxBufferedDocs option

maxBufferedDocs is a minimal number of documents required before the buffered in-memory documents are written into a new Segment

Default value is 10

  • access: public
integer getMaxBufferedDocs ()
getMaxMergeDocs (line 317)

Retrieve index maxMergeDocs option

maxMergeDocs is a largest number of documents ever merged by addDocument(). Small values (e.g., less than 10,000) are best for interactive indexing, as this limits the length of pauses while indexing to a few seconds. Larger values are best for batched indexing and speedier searches.

Default value is PHP_INT_MAX

  • access: public
integer getMaxMergeDocs ()
getMergeFactor (line 356)

Retrieve index mergeFactor option

mergeFactor determines how often segment indices are merged by addDocument(). With smaller values, less RAM is used while indexing, and searches on unoptimized indices are faster, but indexing speed is slower. With larger values, more RAM is used during indexing, and while searches on unoptimized indices are slower, indexing is faster. Thus larger values (> 10) are best for batch index creation, and smaller values (< 10) for indices that are interactively maintained.

Default value is 10

  • access: public
integer getMergeFactor ()
getSimilarity (line 710)

Retrive similarity used by index reader

  • access: public
hasDeletions (line 750)

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

  • access: public
boolean hasDeletions ()
norm (line 723)

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

  • access: public
float norm (integer $id, string $fieldName)
  • integer $id
  • string $fieldName
optimize (line 846)

Optimize index.

Merges all segments into one

  • access: public
void optimize ()
setMaxBufferedDocs (line 300)

Set index maxBufferedDocs option

maxBufferedDocs is a minimal number of documents required before the buffered in-memory documents are written into a new Segment

Default value is 10

  • access: public
void setMaxBufferedDocs (integer $maxBufferedDocs)
  • integer $maxBufferedDocs
setMaxMergeDocs (line 334)

Set index maxMergeDocs option

maxMergeDocs is a largest number of documents ever merged by addDocument(). Small values (e.g., less than 10,000) are best for interactive indexing, as this limits the length of pauses while indexing to a few seconds. Larger values are best for batched indexing and speedier searches.

Default value is PHP_INT_MAX

  • access: public
void setMaxMergeDocs (integer $maxMergeDocs)
  • integer $maxMergeDocs
setMergeFactor (line 378)

Set index mergeFactor option

mergeFactor determines how often segment indices are merged by addDocument(). With smaller values, less RAM is used while indexing, and searches on unoptimized indices are faster, but indexing speed is slower. With larger values, more RAM is used during indexing, and while searches on unoptimized indices are slower, indexing is faster. Thus larger values (> 10) are best for batch index creation, and smaller values (< 10) for indices that are interactively maintained.

Default value is 10

  • access: public
void setMergeFactor ( $mergeFactor, integer $maxMergeDocs)
  • integer $maxMergeDocs
  • $mergeFactor
termDocs (line 593)

Returns an array of all the documents which contain term.

  • access: public
array termDocs (Zend_Search_Lucene_Index_Term $term)
termPositions (line 636)

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)
terms (line 863)

Returns an array of all terms in this index.

  • access: public
array terms ()
undeleteAll (line 906)

Undeletes all documents currently marked as deleted in this index.

  • access: public
  • todo: Implementation
void undeleteAll ()

Documentation generated on Thu, 18 Jan 2007 09:56:27 -0800 by phpDocumentor 1.3.1