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.
Located in /lucene-defs.php (line 426)
search | --lucene_connection | --lucene_msg
Class | Description |
---|---|
![]() |
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. |
True if message has been built
Error message if any error occurred
Object containing lucene fields
Type/name of this message
Array containing XML tags
Inherited from lucene_connection
lucene_connection::$connected
lucene_connection::$enabled
lucene_connection::$host
lucene_connection::$message
lucene_connection::$port
lucene_connection::$responsebuf
lucene_connection::$sockfp
lucene_connection::$timeoutsecs
lucene_connection::$timer
Inherited from search
search::$date_end
search::$date_fieldname
search::$date_start
search::$executed
search::$hit
search::$max_results
search::$query
search::$searchterm
search::$skip_results
search::$title
Constructor
Notes: The application is either specified in the formal paramters or it can be determined for an Axyl application by using the APP_PREFIX which is unique to the application. This is the recommended option. Other developers have, however, also used the configvalue 'Lucene Application' for some reason, so this is still supported here. If none of these methods results in a valid identifier, 'default' is used.
Add a field to the fieldset.
Add a new XML tag object to this Lucene message
Sends the current message to Lucene, and checks for protocol errors in the received response.
Specify the application. The application is the name of a configuration
set which has been specified either by a control message, or by using configuration files on the server. A given configuration set identified by an application name can have specific fields already defined, such as Sort: or Domain: etc. Notes: The 'Application' header can only appear once in the message.
Specify a domain. A domain is an identifier which groups indexed objects internally to Lucene. This allows searches on multiple archives of documents in a single Lucene installation.
Notes: There may be zero or more domain headers in the message. If it does not appear, then any domain header defined for the application will be applied on its own. Otherwise any definitions added by this method are OR'd with any specified in the application config. NB: If no domains are specified anywhere, any searching will be done across all domains (which would probably yield very confusing return data!).
Inherited From lucene_connection
lucene_connection::lucene_connection()
lucene_connection::send()
lucene_connection::set_timeout()
Inherited From search
search::search()
search::clear_daterange()
search::clear_search()
search::does_not_match()
search::has_daterange()
search::hitcount()
search::initialise()
search::match()
search::may_match()
search::must_match()
search::reset_search()
search::set_daterange()
search::set_maxresults()
search::set_skipresults()
search::termcount()
Documentation generated by phpDocumentor 1.3.0RC3