net.sf.mmm.search.engine.api

Interface SearchHit

All Superinterfaces:

AttributeReadId<Long>, SearchEntry

All Known Implementing Classes:

SearchHitImpl

public interface SearchHit
extends SearchEntry

This is the interface for a single hit of a search. It represents any content (web-page, document, etc.) that is represented by a single URI.
ATTENTION: Depending on the implementation it might be expensive to call methods multiple times.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	HIGHLIGHT_CUT_TEXT
static String	HIGHLIGHT_END_TAG
static String	HIGHLIGHT_START_TAG
static SearchHit[]	NO_HITS An emtpy SearchHit array.

Fields inherited from interface net.sf.mmm.search.api.SearchEntry

FIELD_CREATOR, FIELD_CUSTOM_ID, FIELD_ID, FIELD_KEYWORDS, FIELD_LANGUAGE, FIELD_SIZE, FIELD_SOURCE, FIELD_TEXT, FIELD_TITLE, FIELD_TYPE, FIELD_URI

Method Summary

Modifier and Type	Method and Description
String	getEntryId() This method gets the ID of this hit in the search index.
String	getHighlightedText() This method gets an excerpt of the plain text of the content that contains terms of the search query as a highlighted html fragment.
double	getScore() This method gets the score of this hit.
int	getScore(int maximum) This method gets the score of this hit as an integer value in the range from 0 to maximum.

Methods inherited from interface net.sf.mmm.search.api.SearchEntry

getCreator, getCustomId, getField, getField, getFieldAsString, getFieldNames, getId, getSize, getSource, getText, getTitle, getType, getUri

Field Detail

HIGHLIGHT_START_TAG

static final String HIGHLIGHT_START_TAG

See Also:

getHighlightedText(), Constant Field Values

HIGHLIGHT_END_TAG

static final String HIGHLIGHT_END_TAG

See Also:

getHighlightedText(), Constant Field Values

HIGHLIGHT_CUT_TEXT

static final String HIGHLIGHT_CUT_TEXT

See Also:

getHighlightedText(), Constant Field Values

NO_HITS

static final SearchHit[] NO_HITS

An emtpy SearchHit array.

Method Detail

getEntryId

String getEntryId()

This method gets the ID of this hit in the search index. It can be used to retrieve the entry again. It is explicitly unspecified and may vary in implementations if this is the same as SearchEntry.getId().

Returns:

the ID of this hit.

getScore

double getScore()

This method gets the score of this hit. It is a positive value in the range from 0 to 1, where 1 represents a perfect hit and 0 represents a hit that has nothing in common with the search query. A hit will typically NOT have a score of 0 but the score may be close to 0.

Returns:

the score of this hit.

getScore

int getScore(int maximum)

This method gets the score of this hit as an integer value in the range from 0 to maximum. The higher the score the better the hit. This method is useful to view the score as a percentage value (with a maximum of 100) or a number of stars (e.g. with a maximum of 5).

Parameters:

maximum - is the maximum score

Returns:

the score of this hit.

See Also:

getScore()

getHighlightedText

String getHighlightedText()

This method gets an excerpt of the plain text of the content that contains terms of the search query as a highlighted html fragment.
The highlighted terms should be surrounded by HIGHLIGHT_START_TAG and HIGHLIGHT_END_TAG and parts of the text that have been cut out should be replaced with HIGHLIGHT_CUT_TEXT. An implementing search-engine component may allow to override these defaults for custom needs.

Returns:

the highlighted text of this hit.

See Also:

SearchEntry.getText()