\Zend_Search_Lucene
- Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- License: http://framework.zend.com/license/new-bsd New BSD License
Synopsis
class Zend_Search_Lucene
implements
Zend_Search_Lucene_Interface
{
- // constants
- const FORMAT_PRE_2_1 = 0;
- const FORMAT_2_1 = 1;
- const FORMAT_2_3 = 2;
- const GENERATION_RETRIEVE_COUNT = 10;
- const GENERATION_RETRIEVE_PAUSE = 50;
- // members
- private static $_defaultSearchField = NULL;
- private static integer $_resultSetLimit = 0;
- private static integer $_termsPerQueryLimit = 1024;
- private Zend_Search_Lucene_Storage_Directory $_directory = NULL;
- private boolean $_closeDirOnExit = true;
- private Zend_Search_Lucene_Index_Writer $_writer = NULL;
- private array $_segmentInfos = ;
- private integer $_docCount = 0;
- private boolean $_hasChanges = false;
- private boolean $_closed = false;
- private integer $_refCount = 0;
- private $_generation;
- private $_formatVersion;
- private Zend_Search_Lucene_TermStreamsPriorityQueue $_termsStream = NULL;
- // methods
- public static Zend_Search_Lucene_Interface create()
- public static Zend_Search_Lucene_Interface open()
- public static integer getActualGeneration()
- public integer getGeneration()
- public static string getSegmentFileName()
- public integer getFormatVersion()
- public void setFormatVersion()
- private void _readPre21SegmentsFile()
- private void _readSegmentsFile()
- public void __construct()
- private void _close()
- public void addReference()
- public void removeReference()
- public void __destruct()
- private Zend_Search_Lucene_Index_Writer _getIndexWriter()
- public Zend_Search_Lucene_Storage_Directory getDirectory()
- public integer count()
- public integer maxDoc()
- public integer numDocs()
- public boolean isDeleted()
- public static void setDefaultSearchField()
- public static string getDefaultSearchField()
- public static void setResultSetLimit()
- public static integer getResultSetLimit()
- public static void setTermsPerQueryLimit()
- public static integer getTermsPerQueryLimit()
- public integer getMaxBufferedDocs()
- public void setMaxBufferedDocs()
- public integer getMaxMergeDocs()
- public void setMaxMergeDocs()
- public integer getMergeFactor()
- public void setMergeFactor()
- public array find()
- public array getFieldNames()
- public Zend_Search_Lucene_Document getDocument()
- public boolean hasTerm()
- public array termDocs()
- public Zend_Search_Lucene_Index_DocsFilter termDocsFilter()
- public integer termFreqs()
- public array termPositions()
- public integer docFreq()
- public Zend_Search_Lucene_Search_Similarity getSimilarity()
- public float norm()
- public boolean hasDeletions()
- public void delete()
- public void addDocument()
- private void _updateDocCount()
- public void commit()
- public void optimize()
- public array terms()
- public void resetTermsStream()
- public void skipTo()
- public Zend_Search_Lucene_Index_Term|null nextTerm()
- public Zend_Search_Lucene_Index_Term|null currentTerm()
- public void closeTermsStream()
- public void undeleteAll()
Hierarchy
Implements
Tasks
Line | Task |
---|---|
302 | check if we can use some modification of Apache Lucene generation determination algorithm |
1500+ | undeleteAll processing. |
1648+ | Implementation |
Constants
Name | Value |
---|---|
FORMAT_PRE_2_1 | 0 |
FORMAT_2_1 | 1 |
FORMAT_2_3 | 2 |
GENERATION_RETRIEVE_COUNT | 10 |
GENERATION_RETRIEVE_PAUSE | 50 |
Members
private
- $_closeDirOnExit
—
boolean
File system adapter closing option - $_closed
—
boolean
Signal, that index is already closed, changes are fixed and resources are cleaned up - $_defaultSearchField
—
string
Default field name for search - $_directory
—
Zend_Search_Lucene_Storage_Directory
File system adapter. - $_docCount
—
integer
Number of documents in this index. - $_formatVersion
—
integer
Index format version - $_generation
—
integer
Current segment generation - $_hasChanges
—
boolean
Flag for index changes - $_refCount
—
integer
Number of references to the index object - $_resultSetLimit
—
integer
Result set limit - $_segmentInfos
—
array
Array of Zend_Search_Lucene_Index_SegmentInfo objects for current version of index. - $_termsPerQueryLimit
—
integer
Terms per query limit - $_termsStream
—
Zend_Search_Lucene_TermStreamsPriorityQueue
Terms stream priority queue object - $_writer
—
Zend_Search_Lucene_Index_Writer
Writer for this index, not instantiated unless required.
Methods
private
- _close() — Close current index and free resources
- _getIndexWriter() — Returns an instance of Zend_Search_Lucene_Index_Writer for the index
- _readPre21SegmentsFile() — Read segments file for pre-2.1 Lucene index format
- _readSegmentsFile() — Read segments file
- _updateDocCount() — Update document counter
public
- __construct() — Opens the index.
- __destruct() — Object destructor
- addDocument() — Adds a document to this index.
- addReference() — Add reference to the index object
- closeTermsStream() — Close terms stream
- commit() — Commit changes resulting from delete() or undeleteAll() operations.
- count() — Returns the total number of documents in this index (including deleted documents).
- create() — Create index
- currentTerm() — Returns term in current position
- delete() — Deletes a document from the index.
- docFreq() — Returns the number of documents in this index containing the $term.
- find() — Performs a query against the index and returns an array of Zend_Search_Lucene_Search_QueryHit objects.
- getActualGeneration() — Get current generation number
- getDefaultSearchField() — Get default search field.
- getDirectory() — Returns the Zend_Search_Lucene_Storage_Directory instance for this index.
- getDocument() — Returns a Zend_Search_Lucene_Document object for the document number $id in this index.
- getFieldNames() — Returns a list of all unique field names that exist in this index.
- getFormatVersion() — Get index format version
- getGeneration() — Get generation number associated with this index instance
- getMaxBufferedDocs() — Retrieve index maxBufferedDocs option
- getMaxMergeDocs() — Retrieve index maxMergeDocs option
- getMergeFactor() — Retrieve index mergeFactor option
- getResultSetLimit() — Get result set limit.
- getSegmentFileName() — Get segments file name
- getSimilarity() — Retrive similarity used by index reader
- getTermsPerQueryLimit() — Get result set limit.
- hasDeletions() — Returns true if any documents have been deleted from this index.
- hasTerm() — Returns true if index contain documents with specified term.
- isDeleted() — Checks, that document is deleted
- maxDoc() — Returns one greater than the largest possible document number.
- nextTerm() — Scans terms dictionary and returns next term
- norm() — Returns a normalization factor for "field, document" pair.
- numDocs() — Returns the total number of non-deleted documents in this index.
- open() — Open index
- optimize() — Optimize index.
- removeReference() — Remove reference from the index object
- resetTermsStream() — Reset terms stream.
- setDefaultSearchField() — Set default search field.
- setFormatVersion() — Set index format version.
- setMaxBufferedDocs() — Set index maxBufferedDocs option
- setMaxMergeDocs() — Set index maxMergeDocs option
- setMergeFactor() — Set index mergeFactor option
- setResultSetLimit() — Set result set limit.
- setTermsPerQueryLimit() — Set terms per query limit.
- skipTo() — Skip terms stream up to specified term preffix.
- termDocs() — Returns IDs of all documents containing term.
- termDocsFilter() — Returns documents filter for all documents containing term.
- termFreqs() — Returns an array of all term freqs.
- termPositions() — Returns an array of all term positions in the documents.
- terms() — Returns an array of all terms in this index.
- undeleteAll() — Undeletes all documents currently marked as deleted in this index.