Class lucene_querymsg

Description

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.

Located in /lucene-defs.php (line 938)

search
   |
   --lucene_connection
      |
      --lucene_msg
         |
         --lucene_message
            |
            --lucene_querymsg
Direct descendents
Class Description
 class lucene_search The lucene search class
Variable Summary
Method Summary
 lucene_querymsg lucene_querymsg ([string $application = "?"], [string $host = ""], [string $port = ""])
 void send ([integer $timeoutsecs = ""])
 void set_query (string $query)
Variables
Methods
Constructor lucene_querymsg (line 951)

Constructor Make a new Lucene query message. You can specify the application to use here, and also an optional query string to send.

lucene_querymsg lucene_querymsg ([string $application = "?"], [string $host = ""], [string $port = ""])
  • string $application: Optional application specifier.
  • string $host: Hostname or IP of Lucene server
  • string $port: Port of Lucene server
send (line 975)

Send the message to Lucene, and then post-process the response for

query hits. The hitcount is extracted, followed by the hits, which may comprise multiple fields. A hit is thus defined as an array of fields, and each hit is put into a single container array called 'hit', which is a property of the parent class 'search'.

void send ([integer $timeoutsecs = ""])
  • integer $timeoutsecs: Override for timeout in seconds

Redefinition of:
lucene_msg::send()
Sends the current message to Lucene, and checks for protocol errors in the received response.
set_query (line 961)

Set the query for this message. There can be only one query defined.

This method can be called repeatedly, and each time it is called the new value will replace the old one.

void set_query (string $query)
  • string $query: The query to submit to Lucene.

Inherited Methods

Inherited From lucene_message

 lucene_message::lucene_message()
 lucene_message::define_field()
 lucene_message::set_first()
 lucene_message::set_limit()
 lucene_message::set_range()
 lucene_message::set_returnfields()
 lucene_message::set_sortorder()
 lucene_message::set_stopwords()

Inherited From lucene_msg

 lucene_msg::lucene_msg()
 lucene_msg::add_field()
 lucene_msg::add_xmltag()
 lucene_msg::clear()
 lucene_msg::send()
 lucene_msg::set_application()
 lucene_msg::set_domain()

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