ClassInterface Zend_Search_Lucene_Interface

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

Located in /Search/Lucene/Interface.php (line 28)


	
			
Method Summary
 static string getDefaultSearchField ()
 static void setDefaultSearchField (string $fieldName)
 void close ()
 void commit ()
 integer count ()
 array find (mixed $query)
 array getFieldNames ([boolean $indexed = false])
 integer getMaxBufferedDocs ()
 integer getMaxMergeDocs ()
 integer getMergeFactor ()
 boolean hasDeletions ()
 boolean isDeleted (integer $id)
 integer maxDoc ()
 float norm (integer $id, string $fieldName)
 integer numDocs ()
 void optimize ()
 void setMaxBufferedDocs (integer $maxBufferedDocs)
 void setMaxMergeDocs (integer $maxMergeDocs)
 void setMergeFactor ( $mergeFactor, integer $maxMergeDocs)
 array terms ()
 void undeleteAll ()
Methods
static getDefaultSearchField (line 94)

Get default search field.

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

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

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
addDocument (line 295)

Adds a document to this index.

  • access: public
void addDocument (Zend_Search_Lucene_Document $document)
close (line 35)

Close current index and free resources

  • access: public
void close ()
commit (line 300)

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

  • access: public
void commit ()
count (line 49)

Returns the total number of documents in this index (including deleted documents).

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

Deletes a document from the index.

$id is an internal document id

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

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

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

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

Returns the Zend_Search_Lucene_Storage_Directory instance for this index.

  • access: public
getDocument (line 212)

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

  • access: public
getFieldNames (line 203)

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

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

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 132)

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 165)

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 263)

Retrive similarity used by index reader

  • access: public
hasDeletions (line 279)

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

  • access: public
boolean hasDeletions ()
hasTerm (line 222)

Returns true if index contain documents with specified term.

Is used for query optimization.

  • access: public
boolean hasTerm (Zend_Search_Lucene_Index_Term $term)
isDeleted (line 74)

Checks, that document is deleted

  • throws: Zend_Search_Lucene_Exception Exception is thrown if $id is out of the range
  • access: public
boolean isDeleted (integer $id)
  • integer $id
maxDoc (line 58)

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.

  • access: public
integer maxDoc ()
norm (line 272)

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

  • access: public
float norm (integer $id, string $fieldName)
  • integer $id
  • string $fieldName
numDocs (line 65)

Returns the total number of non-deleted documents in this index.

  • access: public
integer numDocs ()
optimize (line 307)

Optimize index.

Merges all segments into one

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

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 146)

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 184)

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 230)

Returns IDs of all the documents containing term.

  • access: public
array termDocs (Zend_Search_Lucene_Index_Term $term)
termFreqs (line 239)

Returns an array of all term freqs.

Return array structure: array( docId => freq, ...)

  • access: public
integer termFreqs (Zend_Search_Lucene_Index_Term $term)
termPositions (line 248)

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 314)

Returns an array of all terms in this index.

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

Undeletes all documents currently marked as deleted in this index.

  • access: public
void undeleteAll ()

Documentation generated on Sun, 27 May 2007 23:25:05 -0700 by phpDocumentor 1.3.2