net.sf.mmm.search.engine.base

Class SearchHitImpl

java.lang.Object

net.sf.mmm.util.component.base.AbstractLoggableObject

net.sf.mmm.search.base.AbstractSearchEntry

net.sf.mmm.search.engine.base.SearchHitImpl

All Implemented Interfaces:

SearchEntry, SearchHit, AttributeReadId<Long>

public class SearchHitImpl
extends AbstractSearchEntry
implements SearchHit

This is the abstract base implementation of the SearchHit interface.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private SearchEntry	entry the actual entry this hit delegates to
private String	entryId
private SearchHighlighter	highlighter the highlighter
private double	score

Fields inherited from interface net.sf.mmm.search.engine.api.SearchHit

HIGHLIGHT_CUT_TEXT, HIGHLIGHT_END_TAG, HIGHLIGHT_START_TAG, NO_HITS

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

Constructor Summary

Constructors

Constructor and Description
SearchHitImpl(SearchEntry searchEntry, String entryId, double hitScore, SearchHighlighter searchHighlighter) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getEntryId() This method gets the ID of this hit in the search index.
Object	getField(String name) This method is a generic accessor for fields of this entry.
<T> T	getField(String name, Class<T> type) This method is a generic accessor for fields of this entry with a specific type.
String	getFieldAsString(String name) This method is a shortcut for getField(name, String.class).
Iterator<String>	getFieldNames() This method gets the names of all fields that are defined (NOT null).
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 class net.sf.mmm.search.base.AbstractSearchEntry

equals, getCreator, getCustomId, getId, getSize, getSource, getText, getTitle, getType, getUri, hashCode, toString

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableObject

getLogger

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getCreator, getCustomId, getId, getSize, getSource, getText, getTitle, getType, getUri

Field Detail

entry

private final SearchEntry entry

the actual entry this hit delegates to

entryId

private final String entryId

See Also:

AbstractSearchEntry.getId()

score

private final double score

See Also:

getScore()

highlighter

private final SearchHighlighter highlighter

the highlighter

Constructor Detail

SearchHitImpl

public SearchHitImpl(SearchEntry searchEntry,
                     String entryId,
                     double hitScore,
                     SearchHighlighter searchHighlighter)

The constructor.

Parameters:

searchEntry - is the actual entry this hit delegates to.

entryId - is the entry-ID.

hitScore - is the score of the hit.

searchHighlighter - is the highlighter used for highlighting.

Method Detail

getScore

public 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.

Specified by:

getScore in interface SearchHit

Returns:

the score of this hit.

getScore

public 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).

Specified by:

getScore in interface SearchHit

Parameters:

maximum - is the maximum score

Returns:

the score of this hit.

See Also:

SearchHit.getScore()

getHighlightedText

public 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 SearchHit.HIGHLIGHT_START_TAG and SearchHit.HIGHLIGHT_END_TAG and parts of the text that have been cut out should be replaced with SearchHit.HIGHLIGHT_CUT_TEXT. An implementing search-engine component may allow to override these defaults for custom needs.

Specified by:

getHighlightedText in interface SearchHit

Returns:

the highlighted text of this hit.

See Also:

SearchEntry.getText()

getEntryId

public 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().

Specified by:

getEntryId in interface SearchHit

Returns:

the ID of this hit.

getFieldAsString

public String getFieldAsString(String name)

This method is a shortcut for getField(name, String.class).

Specified by:

getFieldAsString in interface SearchEntry

Overrides:

getFieldAsString in class AbstractSearchEntry

Parameters:

name - is the name of the requested field.

Returns:

the value of the requested field or null if no field exists for the given name.

getField

public Object getField(String name)

This method is a generic accessor for fields of this entry. For the predefine fields (see FIELD_* constants like SearchEntry.FIELD_TEXT) there are specific getter methods like SearchEntry.getText().

Specified by:

getField in interface SearchEntry

Parameters:

name - is the name of the requested field.

Returns:

the value of the field in its original type.

See Also:

SearchEntry.getField(String, Class)

getField

public <T> T getField(String name,
                      Class<T> type)

This method is a generic accessor for fields of this entry with a specific type.
The type String will always work. Other types have to be compatible to the field type (or a RuntimeException will be thrown).

Specified by:

getField in interface SearchEntry

Type Parameters:

T - is the generic type expected for the requested field-value (see parameter type).

Parameters:

name - is the name of the requested field.

type - is the type of the requested field.

Returns:

the value of the requested field or null if no field exists for the given name.

getFieldNames

public Iterator<String> getFieldNames()

This method gets the names of all fields that are defined (NOT null).

Specified by:

getFieldNames in interface SearchEntry

Returns:

a read-only iterator of the field names.