Zend_Search_LuceneLocated in /Zend/Search/Lucene.php (line 71)
static create (line 139)
Create index
static getDefaultSearchField (line 363)
Get default search field.
Null means, that search is performed through all fields by default
static open (line 150)
Open index
static setDefaultSearchField (line 351)
Set default search field.
Null means, that search is performed through all fields by default
Default value is null
Constructor __construct (line 164)
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.
Destructor __destruct (line 241)
Object destructor
commit (line 936)
Commit changes resulting from delete() or undeleteAll() operations.
count (line 284)
Returns the total number of documents in this index (including deleted documents).
delete (line 882)
Deletes a document from the index.
$id is an internal document id
docFreq (line 804)
Returns the number of documents in this index containing the $term.
find (line 485)
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.
getDirectory (line 273)
Returns the Zend_Search_Lucene_Storage_Directory instance for this index.
getDocument (line 622)
Returns a Zend_Search_Lucene_Document object for the document number $id in this index.
getFieldNames (line 605)
Returns a list of all unique field names that exist in this index.
getIndexWriter (line 258)
Returns an instance of Zend_Search_Lucene_Index_Writer for the index
getMaxBufferedDocs (line 378)
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
getMaxMergeDocs (line 410)
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
getMergeFactor (line 449)
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
getSimilarity (line 823)
Retrive similarity used by index reader
hasDeletions (line 863)
Returns true if any documents have been deleted from this index.
hasTerm (line 689)
Returns true if index contain documents with specified term.
Is used for query optimization.
isDeleted (line 324)
Checks, that document is deleted
maxDoc (line 296)
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.
norm (line 836)
Returns a normalization factor for "field, document" pair.
numDocs (line 306)
Returns the total number of non-deleted documents in this index.
optimize (line 959)
Optimize index.
Merges all segments into one
setMaxBufferedDocs (line 393)
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
setMaxMergeDocs (line 427)
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
setMergeFactor (line 471)
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
termDocs (line 706)
Returns an array of all the documents which contain term.
termPositions (line 749)
Returns an array of all term positions in the documents.
Return array structure: array( docId => array( pos1, pos2, ...), ...)
terms (line 976)
Returns an array of all terms in this index.
undeleteAll (line 1019)
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