| [ Index ] |
PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008] |
[Source view] [Print] [Project Stats]
Zend Framework LICENSE
| Copyright: | Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com) |
| License: | http://framework.zend.com/license/new-bsd New BSD License |
| File Size: | 1084 lines (31 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Zend_Search_Lucene:: (39 methods):
create()
open()
__construct()
_close()
addReference()
removeReference()
__destruct()
getIndexWriter()
getDirectory()
count()
maxDoc()
numDocs()
isDeleted()
setDefaultSearchField()
getDefaultSearchField()
getMaxBufferedDocs()
setMaxBufferedDocs()
getMaxMergeDocs()
setMaxMergeDocs()
getMergeFactor()
setMergeFactor()
find()
getFieldNames()
getDocument()
hasTerm()
termDocs()
termFreqs()
termPositions()
docFreq()
getSimilarity()
norm()
hasDeletions()
delete()
addDocument()
_updateDocCount()
commit()
optimize()
terms()
undeleteAll()
Class: Zend_Search_Lucene - X-Ref
| create($directory) X-Ref |
| Create index param: mixed $directory return: Zend_Search_Lucene_Interface |
| open($directory) X-Ref |
| Open index param: mixed $directory return: Zend_Search_Lucene_Interface |
| __construct($directory = null, $create = false) X-Ref |
| 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. param: mixed $directory |
| _close() X-Ref |
| Close current index and free resources |
| addReference() X-Ref |
| Add reference to the index object |
| removeReference() X-Ref |
| Remove reference from the index object When reference count becomes zero, index is closed and resources are cleaned up |
| __destruct() X-Ref |
| Object destructor |
| getIndexWriter() X-Ref |
| Returns an instance of Zend_Search_Lucene_Index_Writer for the index return: Zend_Search_Lucene_Index_Writer |
| getDirectory() X-Ref |
| Returns the Zend_Search_Lucene_Storage_Directory instance for this index. return: Zend_Search_Lucene_Storage_Directory |
| count() X-Ref |
| Returns the total number of documents in this index (including deleted documents). return: integer |
| maxDoc() X-Ref |
| 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. return: integer |
| numDocs() X-Ref |
| Returns the total number of non-deleted documents in this index. return: integer |
| isDeleted($id) X-Ref |
| Checks, that document is deleted param: integer $id return: boolean |
| setDefaultSearchField($fieldName) X-Ref |
| Set default search field. Null means, that search is performed through all fields by default Default value is null param: string $fieldName |
| getDefaultSearchField() X-Ref |
| Get default search field. Null means, that search is performed through all fields by default return: string |
| getMaxBufferedDocs() X-Ref |
| 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 return: integer |
| setMaxBufferedDocs($maxBufferedDocs) X-Ref |
| 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 param: integer $maxBufferedDocs |
| getMaxMergeDocs() X-Ref |
| 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 return: integer |
| setMaxMergeDocs($maxMergeDocs) X-Ref |
| 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 param: integer $maxMergeDocs |
| getMergeFactor() X-Ref |
| 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 return: integer |
| setMergeFactor($mergeFactor) X-Ref |
| 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 param: integer $maxMergeDocs |
| find($query) X-Ref |
| 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. param: mixed $query return: array Zend_Search_Lucene_Search_QueryHit |
| getFieldNames($indexed = false) X-Ref |
| Returns a list of all unique field names that exist in this index. param: boolean $indexed return: array |
| getDocument($id) X-Ref |
| Returns a Zend_Search_Lucene_Document object for the document number $id in this index. param: integer|Zend_Search_Lucene_Search_QueryHit $id return: Zend_Search_Lucene_Document |
| hasTerm(Zend_Search_Lucene_Index_Term $term) X-Ref |
| Returns true if index contain documents with specified term. Is used for query optimization. param: Zend_Search_Lucene_Index_Term $term return: boolean |
| termDocs(Zend_Search_Lucene_Index_Term $term) X-Ref |
| Returns IDs of all the documents containing term. param: Zend_Search_Lucene_Index_Term $term return: array |
| termFreqs(Zend_Search_Lucene_Index_Term $term) X-Ref |
| Returns an array of all term freqs. Result array structure: array(docId => freq, ...) param: Zend_Search_Lucene_Index_Term $term return: integer |
| termPositions(Zend_Search_Lucene_Index_Term $term) X-Ref |
| Returns an array of all term positions in the documents. Result array structure: array(docId => array(pos1, pos2, ...), ...) param: Zend_Search_Lucene_Index_Term $term return: array |
| docFreq(Zend_Search_Lucene_Index_Term $term) X-Ref |
| Returns the number of documents in this index containing the $term. param: Zend_Search_Lucene_Index_Term $term return: integer |
| getSimilarity() X-Ref |
| Retrive similarity used by index reader return: Zend_Search_Lucene_Search_Similarity |
| norm($id, $fieldName) X-Ref |
| Returns a normalization factor for "field, document" pair. param: integer $id param: string $fieldName return: float |
| hasDeletions() X-Ref |
| Returns true if any documents have been deleted from this index. return: boolean |
| delete($id) X-Ref |
| Deletes a document from the index. $id is an internal document id param: integer|Zend_Search_Lucene_Search_QueryHit $id |
| addDocument(Zend_Search_Lucene_Document $document) X-Ref |
| Adds a document to this index. param: Zend_Search_Lucene_Document $document |
| _updateDocCount() X-Ref |
| Update document counter |
| commit() X-Ref |
| Commit changes resulting from delete() or undeleteAll() operations. |
| optimize() X-Ref |
| Optimize index. Merges all segments into one |
| terms() X-Ref |
| Returns an array of all terms in this index. return: array |
| undeleteAll() X-Ref |
| Undeletes all documents currently marked as deleted in this index. |
| Generated: Wed Jan 14 11:33:29 2009 | Cross-referenced by PHPXref 0.7 |