Located in /Zend/Search/Lucene.php (line 71)
Create index
Get default search field.
Null means, that search is performed through all fields by default
Open index
Set default search field.
Null means, that search is performed through all fields by default
Default value is null
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.
Object destructor
Commit changes resulting from delete() or undeleteAll() operations.
Returns the total number of documents in this index (including deleted documents).
Deletes a document from the index.
$id is an internal document id
Returns the number of documents in this index containing the $term.
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.
Returns the Zend_Search_Lucene_Storage_Directory instance for this index.
Returns a Zend_Search_Lucene_Document object for the document number $id in this index.
Returns a list of all unique field names that exist in this index.
Returns an instance of Zend_Search_Lucene_Index_Writer for the index
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
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
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
Retrive similarity used by index reader
Returns true if any documents have been deleted from this index.
Returns true if index contain documents with specified term.
Is used for query optimization.
Checks, that document is deleted
Returns one greater than the largest possible document number.
This may be used to, e.g., determine how big to allocate a structure which will have an element for every document number in an index.
Returns a normalization factor for "field, document" pair.
Returns the total number of non-deleted documents in this index.
Optimize index.
Merges all segments into one
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
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
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
Returns an array of all the documents which contain term.
Returns an array of all term positions in the documents.
Return array structure: array( docId => array( pos1, pos2, ...), ...)
Returns an array of all terms in this index.
Undeletes all documents currently marked as deleted in this index.
Documentation generated on Wed, 21 Feb 2007 11:53:13 -0800 by phpDocumentor 1.3.1