kinosearch1::search::hits(3pm) [debian 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)

KinoSearch1::Searcher(3pm)				User Contributed Perl Documentation				KinoSearch1::Searcher(3pm)

NAME

       KinoSearch1::Searcher - execute searches

SYNOPSIS

	   my $analyzer = KinoSearch1::Analysis::PolyAnalyzer->new(
	       language => 'en',
	   );

	   my $searcher = KinoSearch1::Searcher->new(
	       invindex => $invindex,
	       analyzer => $analyzer,
	   );
	   my $hits = $searcher->search( query => 'foo bar' );

DESCRIPTION

       Use the Searcher class to perform queries against an invindex.

METHODS

   new
	   my $searcher = KinoSearch1::Searcher->new(
	       invindex => $invindex,
	       analyzer => $analyzer,
	   );

       Constructor.  Takes two labeled parameters, both of which are required.

       o   invindex - can be either a path to an invindex, or a KinoSearch1::Store::InvIndex object.

       o   analyzer - An object which subclasses KinoSearch1::Analysis::Analyer, such as a PolyAnalyzer.  This must be identical to the Analyzer
	   used at index-time, or the results won't match up.

   search
	   my $hits = $searcher->search(
	       query  => $query,  # required
	       filter => $filter, # default: undef (no filtering)
	   );

       Process a search and return a Hits object.  search() expects labeled hash-style parameters.

       o   query - Can be either an object which subclasses KinoSearch1::Search::Query, or a query string.  If it's a query string, it will be
	   parsed using a QueryParser and a search will be performed against all indexed fields in the invindex.  For more sophisticated
	   searching, supply Query objects, such as TermQuery and BooleanQuery.

       o   filter - Must be a KinoSearch1::Search::QueryFilter.  Search results will be limited to only those documents which pass through the
	   filter.

Caching a Searcher
       When a Searcher is created, a small portion of the invindex is loaded into memory.  For large document collections, this startup time may
       become noticeable, in which case reusing the searcher is likely to speed up your search application.  Caching a Searcher is especially
       helpful when running a high-activity app under mod_perl.

       Searcher objects always represent a snapshot of an invindex as it existed when the Searcher was created.  If you want the search results to
       reflect modifications to an invindex, you must create a new Searcher after the update process completes.

COPYRIGHT

       Copyright 2005-2010 Marvin Humphrey

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

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