org.apache.lucene.search.postingshighlight

Class Snippet

java.lang.Object

org.apache.lucene.search.postingshighlight.Snippet

public class Snippet
extends Object

Represents a scored highlighted snippet. It's our own arbitrary object that we get back from the postings highlighter when highlighting a document. Every snippet contains its formatted text and its score. The score is needed in case we want to sort snippets by score, they get sorted by position in the text by default.

Constructor Summary

Constructors

Constructor and Description
Snippet(String text, float score, boolean isHighlighted)

Method Summary

Modifier and Type	Method and Description
float	getScore()
String	getText()
boolean	isHighlighted()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Snippet

public Snippet(String text,
               float score,
               boolean isHighlighted)

Method Detail

getText

public String getText()

getScore

public float getScore()

isHighlighted

public boolean isHighlighted()