ClassInterface Zend_Search_Lucene_Interface

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

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

Zend_Search_Lucene_Index_TermsStream_Interface
   |
   --Zend_Search_Lucene_Interface
Method Summary
Description | Methods (details)
static integer getActualGeneration (Zend_Search_Lucene_Storage_Directory $directory)
static string getDefaultSearchField ()
static integer getResultSetLimit ()
static string getSegmentFileName (integer $generation)
static void setDefaultSearchField (string $fieldName)
static void setResultSetLimit (integer $limit)
void addDocument (Zend_Search_Lucene_Document $document)
void addReference ()
void commit ()
integer count ()
void delete (integer|Zend_Search_Lucene_Search_QueryHit $id)
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])
integer getFormatVersion ()
integer getMaxBufferedDocs ()
integer getMaxMergeDocs ()
integer getMergeFactor ()
Zend_Search_Lucene_Search_Similarity getSimilarity ()
boolean hasDeletions ()
boolean hasTerm (Zend_Search_Lucene_Index_Term $term)
boolean isDeleted (integer $id)
integer maxDoc ()
float norm (integer $id, string $fieldName)
integer numDocs ()
void optimize ()
void removeReference ()
void setFormatVersion (int $formatVersion)
void setMaxBufferedDocs (integer $maxBufferedDocs)
void setMaxMergeDocs (integer $maxMergeDocs)
void setMergeFactor ( $mergeFactor, integer $maxMergeDocs)
array termDocs (Zend_Search_Lucene_Index_Term $term, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
Zend_Search_Lucene_Index_DocsFilter termDocsFilter (Zend_Search_Lucene_Index_Term $term, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
integer termFreqs (Zend_Search_Lucene_Index_Term $term, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
array termPositions (Zend_Search_Lucene_Index_Term $term, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
array terms ()
void undeleteAll ()
Methods
Description | Methods (details)
static getActualGeneration (line 58)

Get current generation number

Returns generation number

  1. means pre-2.1 index format
-1 means there are no segments files.

  • throws: Zend_Search_Lucene_Exception
  • access: public
static integer getActualGeneration (Zend_Search_Lucene_Storage_Directory $directory)
static getDefaultSearchField (line 141)

Get default search field.

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

  • access: public
static string getDefaultSearchField ()
static getResultSetLimit (line 159)

Set result set limit.

  1. means no limit

  • access: public
static integer getResultSetLimit ()
static getSegmentFileName (line 66)

Get segments file name

  • access: public
static string getSegmentFileName (integer $generation)
  • integer $generation
static setDefaultSearchField (line 132)

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
static setResultSetLimit (line 150)

Set result set limit.

  1. (default) means no limit

  • access: public
static void setResultSetLimit (integer $limit)
  • integer $limit
addDocument (line 375)

Adds a document to this index.

  • access: public
void addDocument (Zend_Search_Lucene_Document $document)
addReference (line 407)

Add reference to the index object

  • access: public
void addReference ()
commit (line 380)

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

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

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

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

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

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

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

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

Returns the Zend_Search_Lucene_Storage_Directory instance for this index.

  • access: public
Zend_Search_Lucene_Storage_Directory getDirectory ()
getDocument (line 277)

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)
getFieldNames (line 268)

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

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

Get index format version

  • access: public
integer getFormatVersion ()
getMaxBufferedDocs (line 171)

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

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

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

Retrive similarity used by index reader

  • access: public
Zend_Search_Lucene_Search_Similarity getSimilarity ()
hasDeletions (line 359)

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

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

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

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

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

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

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

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

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

Optimize index.

Merges all segments into one

  • access: public
void optimize ()
removeReference (line 416)

Remove reference from the index object

When reference count becomes zero, index is closed and resources are cleaned up

  • access: public
void removeReference ()
setFormatVersion (line 82)

Set index format version.

Index is converted to this format at the nearest upfdate time

  • throws: Zend_Search_Lucene_Exception
  • access: public
void setFormatVersion (int $formatVersion)
  • int $formatVersion
setMaxBufferedDocs (line 183)

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

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

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

Returns IDs of all the documents containing term.

  • access: public
array termDocs (Zend_Search_Lucene_Index_Term $term, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
termDocsFilter (line 308)

Returns documents filter for all documents containing term.

It performs the same operation as termDocs, but return result as Zend_Search_Lucene_Index_DocsFilter object

  • access: public
Zend_Search_Lucene_Index_DocsFilter termDocsFilter (Zend_Search_Lucene_Index_Term $term, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
termFreqs (line 318)

Returns an array of all term freqs.

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

  • access: public
integer termFreqs (Zend_Search_Lucene_Index_Term $term, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
termPositions (line 328)

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_DocsFilter|null $docsFilter = null])
terms (line 394)

Returns an array of all terms in this index.

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

Undeletes all documents currently marked as deleted in this index.

  • access: public
void undeleteAll ()

Inherited Methods

Inherited From Zend_Search_Lucene_Index_TermsStream_Interface

Zend_Search_Lucene_Index_TermsStream_Interface::closeTermsStream()
Zend_Search_Lucene_Index_TermsStream_Interface::currentTerm()
Zend_Search_Lucene_Index_TermsStream_Interface::nextTerm()
Zend_Search_Lucene_Index_TermsStream_Interface::resetTermsStream()
Zend_Search_Lucene_Index_TermsStream_Interface::skipTo()

Documentation generated on Mon, 21 Jun 2010 15:29:33 -0400 by phpDocumentor 1.4.3