Lucy::Highlight::Highlighter - Create and highlight excerpts.
my $highlighter = Lucy::Highlight::Highlighter->new(
searcher => $searcher,
query => $query,
field => 'body'
);
my $hits = $searcher->hits( query => $query );
while ( my $hit = $hits->next ) {
my $excerpt = $highlighter->create_excerpt($hit);
...
}
The Highlighter can be used to select relevant snippets 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.
my $highlighter = Lucy::Highlight::Highlighter->new(
searcher => $searcher, # required
query => $query, # required
field => 'content', # required
excerpt_length => 150, # default: 200
);
searcher - An object which inherits from Searcher, such as an IndexSearcher.
query - Query object or a query string.
field - The name of the field from which to draw the excerpt. The field must marked as be highlightable
(see FieldType).
excerpt_length - Maximum length of the excerpt, in characters.
Take a HitDoc object and return a highlighted excerpt as a string if the HitDoc has a value for the specified field
.
Highlight a small section of text. By default, prepends pre-tag and appends post-tag. This method is called internally by create_excerpt() when assembling an excerpt.
Encode text with HTML entities. This method is called internally by create_excerpt() for each text fragment when assembling an excerpt. A subclass can override this if the text should be encoded differently or not at all.
Setter. The default value is "<strong>".
Accessor.
Setter. The default value is "</strong>".
Accessor.
Accessor.
Accessor.
Accessor for the Lucy::Search::Compiler object derived from query
and searcher
.
Accessor.
Accessor.
Lucy::Highlight::Highlighter isa Clownfish::Obj.