kinosearch1::highlight::highlighter(3pm) [debian man page]

KinoSearch1::Highlight::Highlighter(3pm)		User Contributed Perl Documentation		  KinoSearch1::Highlight::Highlighter(3pm)

NAME

       KinoSearch1::Highlight::Highlighter - create and highlight excerpts

SYNOPSIS

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

DESCRIPTION

       KinoSearch1's Highlighter can be used to select a relevant snippet from a document, and to surround search terms with highlighting tags.
       It handles both stems and phrases correctly and efficiently, using special-purpose data generated at index-time.

METHODS

   new
	   my $highlighter = KinoSearch1::Highlight::Highlighter->new(
	       excerpt_field  => 'bodytext', # required
	       excerpt_length => 150,	     # default: 200
	       formatter      => $formatter, # default: SimpleHTMLFormatter
	       encoder	      => $encoder,   # default: SimpleHTMLEncoder
	   );

       Constructor.  Takes hash-style parameters:

       o   excerpt_field - the name of the field from which to draw the excerpt.  This field must be "vectorized".

       o   excerpt_length - the length of the excerpt, in bytes.  This should probably use characters as a unit instead of bytes, and the behavior
	   is likely to change in the future.

       o   formatter - an object which subclasses KinoSearch1::Highlight::Formatter, used to perform the actual highlighting.

       o   encoder - an object which subclasses KinoSearch1::Highlight::Encoder.  All excerpt text gets passed through the encoder, including
	   highlighted terms.  By default, this is a SimpleHTMLEncoder, which encodes HTML entities.

       o   pre_tag - deprecated.

       o   post_tag - deprecated.

COPYRIGHT

       Copyright 2005-2010 Marvin Humphrey

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

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

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

NAME

       KinoSearch1::QueryParser::QueryParser - transform a string into a Query object

SYNOPSIS

	   my $query_parser = KinoSearch1::QueryParser::QueryParser->new(
	       analyzer => $analyzer,
	       fields	=> [ 'bodytext' ],
	   );
	   my $query = $query_parser->parse( $query_string );
	   my $hits  = $searcher->search( query => $query );

DESCRIPTION

       The QueryParser accepts search strings as input and produces Query objects, suitable for feeding into KinoSearch1::Searcher.

   Syntax
       The following constructs are recognized by QueryParser.

       o   Boolean operators 'AND', 'OR', and 'AND NOT'.

       o   Prepented +plus and -minus, indicating that the labeled entity should be either required or forbidden -- be it a single word, a phrase,
	   or a parenthetical group.

       o   Logical groups, delimited by parentheses.

       o   Phrases, delimited by double quotes.

       o   Field-specific terms, in the form of "fieldname:termtext".  (The field specified by fieldname will be used instead of the QueryParser's
	   default fields).

	   A field can also be given to a logical group, in which case it is the same as if the field had been prepended onto every term in the
	   group.  For example: "foo:(bar baz)" is the same as "foo:bar foo:baz".

METHODS

   new
	   my $query_parser = KinoSearch1::QueryParser::QueryParser->new(
	       analyzer       => $analyzer,	  # required
	       fields	      => [ 'bodytext' ],  # required
	       default_boolop => 'AND', 	  # default: 'OR'
	   );

       Constructor.  Takes hash-style parameters:

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

       o   fields - the names of the fields which will be searched against.  Must be supplied as an arrayref.

       o   default_field - deprecated. Use "fields" instead.

       o   default_boolop - two possible values: 'AND' and 'OR'.  The default is 'OR', which means: return documents which match any of the query
	   terms.  If you want only documents which match all of the query terms, set this to 'AND'.

   parse
	   my $query = $query_parser->parse( $query_string );

       Turn a query string into a Query object.  Depending on the contents of the query string, the returned object could be any one of several
       subclasses of KinoSearch1::Search::Query.

COPYRIGHT

       Copyright 2005-2010 Marvin Humphrey

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

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