The lucene search class
This class inherits the functionality of the generic 'search' class. It extends it to implement a LUCENE search. Use the methods in this class as the mainstay in implementing queries of content from Lucene. Most methods, such as match(), matchfield(), matchrange() etc. store the requirement in the class for subsequent building using the set_*() methods of the lucene classes to set the relevant fields. This is only done when you call execute(), and the query is built from all the composite terms you have added via match() et al.
Located in /lucene-defs.php (line 1214)
search | --lucene_connection | --lucene_msg | --lucene_message | --lucene_querymsg | --lucene_search
Inherited from lucene_querymsg
lucene_querymsg::$sort_limit_exceeded
lucene_querymsg::$sort_memory_exceeded
Inherited from lucene_message
lucene_message::$response
Inherited from lucene_msg
lucene_msg::$built
lucene_msg::$error_msg
lucene_msg::$fieldset
lucene_msg::$type
lucene_msg::$xmltags
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
Create a new lucene search
Add search term: must not match a field value.
This is used to add a search term which defines the value that a given field must not contain for the search to succeed.
Execute the search Here we execute a lucene search, overriding the method in the parent class. This involves building the query string, sending it to the Lucene server, and receiving the search results back.
Add a new search term to match. Search terms can be a single word or compound patterns, Each time one of these is added, it has an operator associated with it - whether this term is a "may have" (OR), or a "must have" (AND) term.
NB: This method overrides the parent method in order to ensure that all boolean logic terms are in upper case as Lucene requires.
Add search term to match a field value.
This is used to add a search term which defines the value that a given field may or may not contain for the search to succeed. For adding terms which are 'free' (as a user might type into a search box for example) then you can use the match() method which this class inherits from the search class.
Add search term to match a field value range.
This is used to add a search term which defines the range of values that a given field may or may not contain for the search to succeed. NB: This method is always a must match (implied AND) search term. In other words the search is always restricted/refined by it.
Add search term: may match a field value.
This is used to add a search term which defines the value that a given field may contain for the search to succeed.
Add search term: must match a field value.
This is used to add a search term which defines the value that a given field must contain for the search to succeed.
Inherited From lucene_querymsg
lucene_querymsg::lucene_querymsg()
lucene_querymsg::send()
lucene_querymsg::set_query()
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