Class | Description |
---|---|
![]() |
The lucene connection class |
![]() |
The lucene msg class. This is a raw class which holds the basic message fields and data and knows how to build them into a full message for sending to the lucene server. |
![]() |
The lucene message class. This class extends its parent class lucene_msg and adds some higher level methods for adding groups of fields to the message. |
![]() |
The lucene query message class. This class inherits all the functionality of the lucene_connection, lucene_msg and lucene_message classes. It adds query-specific methods for searching. |
![]() |
The lucene index message class. This class inherits all the functionality of the lucene_connection, lucene_msg and lucene_message classes. It adds indexing-specific methods. |
![]() |
The lucene unindex message class. This class allows you to remove an item from the Lucene index. You must know the unique ID that identifies the document. |
![]() |
The lucene purge message class. This class allows you to remove all |
![]() |
The lucene utility message class. Used for special Lucene operations. |
![]() |
The lucene search class |
![]() |
The lucene file indexer class. |
Generic search classes
Stopwatch microtimer
XML classes
The name of the field Lucene should assume if none specified
Default type of field: 'Text', 'Date', 'Id'
Mode of index ID generation is by full filename (incl. extension)
Mode of index ID generation is by incrementing integer
Mode of index ID generation is by filename stripped of path and extension
Mode of index ID generation is by full path to file
Used to indicate that a field should be indexed by Lucene
Indicates index fields come from meta tag extraction
Used to indicate that a field should NOT be indexed by Lucene
Used to indicate that a field should NOT be stored by Lucene
Wait on socket forever (well, 24hrs is that, more or less)
Do not wait on socket receive, return immediately
Times to retry timed-out socket sends/receives
Used to indicate that a field should be stored by Lucene
Function to make a backup of the Lucene index. This would commonly
be used after a batch of items have been successfully optimized (which indicates a sound index). The backup will be made to the directory specified in the application .properties file as the property 'Lucene-Backup-Directory=' or, if not there then in the Lucene properties file 'Server.properties' as the same property. If neither of these are defined, the server will attempt to use a sub-directory called {Lucene-Index-Directory}_backup, where {Lucene-Index-Directory} is the index path as already defined in the 'Server.properties' file.
Function to optimize the Lucene index. This would commonly be used after a batch of items have been indexed.
Function to purge the Lucene index of all indexes to documents. Yes, I'll repeat that - it DELETES ALL DOCUMENTS FROM THE INDEX, permanently, finito, shazam, ba-boom, as in "Omigod did I *really* mean to do that!?".
I guess I don't have to warn you to be careful with this, do I?
Documentation generated by phpDocumentor 1.3.0RC3