Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

kinosearch1::search::booleanquery(3pm) [debian man page]

KinoSearch1::Search::BooleanQuery(3pm)			User Contributed Perl Documentation		    KinoSearch1::Search::BooleanQuery(3pm)

NAME

       KinoSearch1::Search::BooleanQuery - match boolean combinations of Queries

SYNOPSIS

	   my $bool_query = KinoSearch1::Search::BooleanQuery->new;
	   $bool_query->add_clause( query => $term_query, occur => 'MUST' );
	   my $hits = $searcher->search( query => $bool_query );

DESCRIPTION

       BooleanQueries are super-Query objects which match boolean combinations of other Queries.

       One way of producing a BooleanQuery is to feed a query string along the lines of "this AND NOT that" to a QueryParser object:

	   my $bool_query = $query_parser->parse( 'this AND NOT that' );

       It's also possible to achieve the same end by manually constructing the query piece by piece:

	   my $bool_query = KinoSearch1::Search::BooleanQuery->new;

	   my $this_query = KinoSearch1::Search::TermQuery->new(
	       term => KinoSearch1::Index::Term->new( 'bodytext', 'this' ),
	   );
	   $bool_query->add_clause( query => $this_query, occur => 'MUST' );

	   my $that_query = KinoSearch1::Search::TermQuery->new(
	       term => KinoSearch1::Index::Term->new( 'bodytext', 'that' ),
	   );
	   $bool_query->add_clause( query => $that_query, occur => 'MUST_NOT' );

       QueryParser objects and hand-rolled Queries can work together:

	   my $general_query = $query_parser->parse($q);
	   my $news_only     = KinoSearch1::Search::TermQuery->new(
	       term => KinoSearch1::Index::Term->new( 'category', 'news' );
	   );
	   $bool_query->add_clause( query => $general_query, occur => 'MUST' );
	   $bool_query->add_clause( query => $news_only,     occur => 'MUST' );

METHODS

   new
	   my $bool_query = KinoSearch1::Search::BooleanQuery->new;

       Constructor. Takes no arguments.

   add_clause
	   $bool_query->add_clause(
	       query => $query, # required
	       occur => 'MUST', # default: 'SHOULD'
	   );

       Add a clause to the BooleanQuery.  Takes hash-style parameters:

       o   query - an object which belongs to a subclass of KinoSearch1::Search::Query.

       o   occur - must be one of three possible values: 'SHOULD', 'MUST', or 'MUST_NOT'.

COPYRIGHT

       Copyright 2005-2010 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc.
       See KinoSearch1 version 1.00.

perl v5.14.2							    2011-11-15				    KinoSearch1::Search::BooleanQuery(3pm)

Check Out this Related Man Page

KinoSearch1::Search::Hits(3pm)				User Contributed Perl Documentation			    KinoSearch1::Search::Hits(3pm)

NAME

       KinoSearch1::Search::Hits - access search results

SYNOPSIS

	   my $hits = $searcher->search( query => $query );
	   $hits->seek( 0, 10 );
	   while ( my $hashref = $hits->fetch_hit_hashref ) {
	       print "<p>$hashref->{title} <em>$hashref->{score}</em></p>
";
	   }

DESCRIPTION

       Hits objects are used to access the results of a search.  By default, a hits object provides access to the top 100 matches; the seek()
       method provides finer-grained control.

       A classic application would be paging through hits.  The first time, seek to a START of 0, and retrieve 10 documents.  If the user wants to
       see more -- and there are more than 10 total hits -- seek to a START of 10, and retrieve 10 more documents.  And so on.

METHODS

   seek
	   $hits->seek( START, NUM_TO_RETRIEVE );

       Position the Hits iterator at START, and capture NUM_TO_RETRIEVE docs.

   total_hits
	   my $num_that_matched = $hits->total_hits;

       Return the total number of documents which matched the query used to produce the Hits object.  (This number is unlikely to match
       NUM_TO_RETRIEVE.)

   fetch_hit
	   while ( my $hit = $hits->fetch_hit ) {
	       # ...
	   }

       Return the next hit as a KinoSearch1::Search::Hit object.

   fetch_hit_hashref
	   while ( my $hashref = $hits->fetch_hit_hashref ) {
	       # ...
	   }

       Return the next hit as a hashref, with the field names as keys and the field values as values.  An entry for "score" will also be present,
       as will an entry for "excerpt" if create_excerpts() was called earlier.	However, if the document contains stored fields named "score" or
       "excerpt", they will not be clobbered.

   create_excerpts
	   my $highlighter = KinoSearch1::Highlight::Highlighter->new(
	       excerpt_field => 'bodytext',
	   );
	   $hits->create_excerpts( highlighter => $highlighter );

       Use the supplied highlighter to generate excerpts.  See KinoSearch1::Highlight::Highlighter.

COPYRIGHT

       Copyright 2005-2010 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc.
       See KinoSearch1 version 1.00.

perl v5.14.2							    2011-11-15					    KinoSearch1::Search::Hits(3pm)
Man Page