Search/Lucene/Interface.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
version: $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces: Zend_Search_Lucene_Interface

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Search_Lucene_Interface
jump to top

Extends from: Zend_Search_Lucene_Index_TermsStream_Interface
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
Methods: getActualGeneration; getSegmentFileName; getFormatVersion; setFormatVersion; getDirectory; count; maxDoc; numDocs; isDeleted; setDefaultSearchField; getDefaultSearchField; setResultSetLimit; getResultSetLimit; getMaxBufferedDocs; setMaxBufferedDocs; getMaxMergeDocs; setMaxMergeDocs; getMergeFactor; setMergeFactor; find; getFieldNames; getDocument; hasTerm; termDocs; termDocsFilter; termFreqs; termPositions; docFreq; getSimilarity; norm; hasDeletions; delete; addDocument; commit; optimize; terms; undeleteAll; addReference; removeReference

Description

Methods

addDocument
jump to class

addDocument(
          Zend_Search_Lucene_Document $document
          )
        
        :

Adds a document to this index.

Arguments

$document: Zend_Search_Lucene_Document

Details

visibility: public
final: false
static: false

addReference
jump to class

addReference(
          
          )
        
        :

Add reference to the index object

Details

visibility: public
final: false
static: false
internal

commit
jump to class

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

Details

visibility: public
final: false
static: false

count
jump to class

count(
          
          )
        
        :
        integer

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

Output

integer

Details

visibility: public
final: false
static: false

delete
jump to class

delete(
          integer|Zend_Search_Lucene_Search_QueryHit $id
          )
        
        :

Deletes a document from the index.

$id is an internal document id

Arguments

$id: integerZend_Search_Lucene_Search_QueryHit

Details

visibility: public
final: false
static: false
throws

docFreq
jump to class

docFreq(
          Zend_Search_Lucene_Index_Term $term
          )
        
        :
        integer

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

Arguments

$term: Zend_Search_Lucene_Index_Term

Output

integer

Details

visibility: public
final: false
static: false

find
jump to class

find(
          mixed $query
          )
        
        :
        array

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.

Arguments

$query: mixed

Output

array: Zend_Search_Lucene_Search_QueryHit

Details

visibility: public
final: false
static: false
throws

getActualGeneration
jump to class

getActualGeneration(
          Zend_Search_Lucene_Storage_Directory $directory
          )
        
        :
        integer

Get current generation number

Returns generation number 0 means pre-2.1 index format -1 means there are no segments files.

Arguments

$directory: Zend_Search_Lucene_Storage_Directory

Output

integer

Details

visibility: public
final: false
static: true
throws

getDefaultSearchField
jump to class

getDefaultSearchField(
          
          )
        
        :
        string

Get default search field.

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

Output

string

Details

visibility: public
final: false
static: true

getDirectory
jump to class

getDirectory(
          
          )
        
        :
        Zend_Search_Lucene_Storage_Directory

Returns the Zend_Search_Lucene_Storage_Directory instance for this index.

Output

Zend_Search_Lucene_Storage_Directory

Details

visibility: public
final: false
static: false

getDocument
jump to class

getDocument(
          integer|Zend_Search_Lucene_Search_QueryHit $id
          )
        
        :
        Zend_Search_Lucene_Document

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

Arguments

$id: integerZend_Search_Lucene_Search_QueryHit

Output

Zend_Search_Lucene_Document

Details

visibility: public
final: false
static: false

getFieldNames
jump to class

getFieldNames(
          boolean $indexed
              =
              false
          )
        
        :
        array

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

Arguments

$indexed: boolean

Output

array

Details

visibility: public
final: false
static: false

getFormatVersion
jump to class

getFormatVersion(
          
          )
        
        :
        integer

Get index format version

Output

integer

Details

visibility: public
final: false
static: false

getMaxBufferedDocs
jump to class

getMaxBufferedDocs(
          
          )
        
        :
        integer

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

Output

integer

Details

visibility: public
final: false
static: false

getMaxMergeDocs
jump to class

getMaxMergeDocs(
          
          )
        
        :
        integer

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

Output

integer

Details

visibility: public
final: false
static: false

getMergeFactor
jump to class

getMergeFactor(
          
          )
        
        :
        integer

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

Output

integer

Details

visibility: public
final: false
static: false

getResultSetLimit
jump to class

getResultSetLimit(
          
          )
        
        :
        integer

Set result set limit.

0 means no limit

Output

integer

Details

visibility: public
final: false
static: true

getSegmentFileName
jump to class

getSegmentFileName(
          integer $generation
          )
        
        :
        string

Get segments file name

Arguments

$generation: integer

Output

string

Details

visibility: public
final: false
static: true

getSimilarity
jump to class

getSimilarity(
          
          )
        
        :
        Zend_Search_Lucene_Search_Similarity

Retrive similarity used by index reader

Output

Zend_Search_Lucene_Search_Similarity

Details

visibility: public
final: false
static: false

hasDeletions
jump to class

hasDeletions(
          
          )
        
        :
        boolean

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

Output

boolean

Details

visibility: public
final: false
static: false

hasTerm
jump to class

hasTerm(
          Zend_Search_Lucene_Index_Term $term
          )
        
        :
        boolean

Returns true if index contain documents with specified term.

Is used for query optimization.

Arguments

$term: Zend_Search_Lucene_Index_Term

Output

boolean

Details

visibility: public
final: false
static: false

isDeleted
jump to class

isDeleted(
          integer $id
          )
        
        :
        boolean

Checks, that document is deleted

Arguments

$id: integer

Output

boolean

Details

visibility: public
final: false
static: false
throws: Exception is thrown if $id is out of the range

maxDoc
jump to class

maxDoc(
          
          )
        
        :
        integer

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.

Output

integer

Details

visibility: public
final: false
static: false

norm
jump to class

norm(
          integer $id, string $fieldName
          )
        
        :
        float

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

Arguments

$id: integer
$fieldName: string

Output

float

Details

visibility: public
final: false
static: false

numDocs
jump to class

numDocs(
          
          )
        
        :
        integer

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

Output

integer

Details

visibility: public
final: false
static: false

optimize
jump to class

optimize(
          
          )
        
        :

Optimize index.

Merges all segments into one

Details

visibility: public
final: false
static: false

removeReference
jump to class

removeReference(
          
          )
        
        :

Remove reference from the index object

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

Details

visibility: public
final: false
static: false
internal

setDefaultSearchField
jump to class

setDefaultSearchField(
          string $fieldName
          )
        
        :

Set default search field.

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

Default value is null

Arguments

$fieldName: string

Details

visibility: public
final: false
static: true

setFormatVersion
jump to class

setFormatVersion(
          int $formatVersion
          )
        
        :

Set index format version.

Index is converted to this format at the nearest upfdate time

Arguments

$formatVersion: int

Details

visibility: public
final: false
static: false
throws

setMaxBufferedDocs
jump to class

setMaxBufferedDocs(
          integer $maxBufferedDocs
          )
        
        :

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

Arguments

$maxBufferedDocs: integer

Details

visibility: public
final: false
static: false

setMaxMergeDocs
jump to class

setMaxMergeDocs(
          integer $maxMergeDocs
          )
        
        :

Set index maxMergeDocs option

Default value is PHP_INT_MAX

Arguments

$maxMergeDocs: integer

Details

visibility: public
final: false
static: false

setMergeFactor
jump to class

setMergeFactor(
           $mergeFactor
          )
        
        :

Set index mergeFactor option

Default value is 10

Arguments

$mergeFactor

Details

visibility: public
final: false
static: false

setResultSetLimit
jump to class

setResultSetLimit(
          integer $limit
          )
        
        :

Set result set limit.

0 (default) means no limit

Arguments

$limit: integer

Details

visibility: public
final: false
static: true

termDocs
jump to class

termDocs(
          Zend_Search_Lucene_Index_Term $term, Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
              =
              null
          )
        
        :
        array

Returns IDs of all the documents containing term.

Arguments

$term: Zend_Search_Lucene_Index_Term
$docsFilter: Zend_Search_Lucene_Index_DocsFilternull

Output

array

Details

visibility: public
final: false
static: false

termDocsFilter
jump to class

termDocsFilter(
          Zend_Search_Lucene_Index_Term $term, Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
              =
              null
          )
        
        :
        Zend_Search_Lucene_Index_DocsFilter

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

Arguments

$term: Zend_Search_Lucene_Index_Term
$docsFilter: Zend_Search_Lucene_Index_DocsFilternull

Output

Zend_Search_Lucene_Index_DocsFilter

Details

visibility: public
final: false
static: false

termFreqs
jump to class

termFreqs(
          Zend_Search_Lucene_Index_Term $term, Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
              =
              null
          )
        
        :
        integer

Returns an array of all term freqs.

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

Arguments

$term: Zend_Search_Lucene_Index_Term
$docsFilter: Zend_Search_Lucene_Index_DocsFilternull

Output

integer

Details

visibility: public
final: false
static: false

termPositions
jump to class

termPositions(
          Zend_Search_Lucene_Index_Term $term, Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
              =
              null
          )
        
        :
        array

Returns an array of all term positions in the documents.

Return array structure: array( docId => array( pos1, pos2, ...), ...)

Arguments

$term: Zend_Search_Lucene_Index_Term
$docsFilter: Zend_Search_Lucene_Index_DocsFilternull

Output

array

Details

visibility: public
final: false
static: false

terms
jump to class

terms(
          
          )
        
        :
        array

Returns an array of all terms in this index.

Output

array

Details

visibility: public
final: false
static: false

undeleteAll
jump to class

undeleteAll(
          
          )
        
        :

Undeletes all documents currently marked as deleted in this index.

Details

visibility: public
final: false
static: false

API Documentation

Search/Lucene/Interface.php

Description

Zend_Search_Lucene_Interfacejump to top

Description

Methods

addDocumentjump to class

Arguments

Details

addReferencejump to class

Details

commitjump to class

Details

countjump to class

Output

Details

deletejump to class

Arguments

Details

docFreqjump to class

Arguments

Output

Details

findjump to class

Arguments

Output

Details

getActualGenerationjump to class

Arguments

Output

Details

getDefaultSearchFieldjump to class

Output

Details

getDirectoryjump to class

Output

Details

getDocumentjump to class

Arguments

Output

Details

getFieldNamesjump to class

Arguments

Output

Details

getFormatVersionjump to class

Output

Details

getMaxBufferedDocsjump to class

Output

Details

getMaxMergeDocsjump to class

Output

Details

getMergeFactorjump to class

Output

Details

getResultSetLimitjump to class

Output

Details

getSegmentFileNamejump to class

Arguments

Output

Details

getSimilarityjump to class

Output

Details

hasDeletionsjump to class

Output

Details

hasTermjump to class

Arguments

Output

Details

isDeletedjump to class

Arguments

Output

Details

maxDocjump to class

Output

Zend_Search_Lucene_Interface
jump to top

addDocument
jump to class

addReference
jump to class

commit
jump to class

count
jump to class

delete
jump to class

docFreq
jump to class

find
jump to class

getActualGeneration
jump to class

getDefaultSearchField
jump to class

getDirectory
jump to class

getDocument
jump to class

getFieldNames
jump to class

getFormatVersion
jump to class

getMaxBufferedDocs
jump to class

getMaxMergeDocs
jump to class

getMergeFactor
jump to class

getResultSetLimit
jump to class

getSegmentFileName
jump to class

getSimilarity
jump to class

hasDeletions
jump to class

hasTerm
jump to class

isDeleted
jump to class

maxDoc
jump to class

norm
jump to class

numDocs
jump to class

optimize
jump to class

removeReference
jump to class

setDefaultSearchField
jump to class

setFormatVersion
jump to class

setMaxBufferedDocs
jump to class

setMaxMergeDocs
jump to class

setMergeFactor
jump to class

setResultSetLimit
jump to class

termDocs
jump to class

termDocsFilter
jump to class

termFreqs
jump to class

termPositions
jump to class

terms
jump to class

undeleteAll
jump to class