senselogic.sitevision.api.search

Interface SearchHighlighter

Deprecated.

This interface will do absolutely nothing as of Sitevision 3.0 (search engine has been replaced). Interface methods will not do anything (i.e. always return null) and this interface will be completely removed in future releases of Sitevision.

@Deprecated
public interface SearchHighlighter

This interface is deprecated and non-functional as of Sitevision 3.0. The Sitevision search engine has been replaced (from Lucene to Solr) and highlighting of arbitrary fields in a search result via SearchHighlighter is no longer possible. In Solr you should specify the field(-s) that should be highlighted when you execute the query.

Since:

Sitevision 2.7_06

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
String	getHighlightedFragment(String aHighlightPreElement, String aHighlightPostElement, SearchHit aSearchHit) Deprecated. As of Sitevision 3.0 this method will always return null. Do not use this interface at all, it will be completely removed in future releases of Sitevision.
String	getHighlightedFragment(String aHighlightPreElement, String aHighlightPostElement, SearchHit aSearchHit, String aHighlightingFieldName) Deprecated. As of Sitevision 3.0 this method will always return null. Do not use this interface at all, it will be completely removed in future releases of Sitevision.

Method Detail

getHighlightedFragment

@Deprecated
String getHighlightedFragment(String aHighlightPreElement,
                                          String aHighlightPostElement,
                                          SearchHit aSearchHit)

Deprecated. As of Sitevision 3.0 this method will always return null. Do not use this interface at all, it will be completely removed in future releases of Sitevision.

Returns a highlighted fragment for the default highlighting field.

Parameters:

aHighlightPreElement - the opening element to the left of a highlighted word(-s), e.g "<strong style=\"background-color:yellow\">"

aHighlightPostElement - the closing element to the right of a highlighted word(-s), e.g "</strong>"

aSearchHit - the search hit that should be highlighted

Returns:

a highlighted text fragment with all matches surrounded with aHighlightPreElement and aHighlightPostElement, null if nothing could be highlighted

getHighlightedFragment

@Deprecated
String getHighlightedFragment(String aHighlightPreElement,
                                          String aHighlightPostElement,
                                          SearchHit aSearchHit,
                                          String aHighlightingFieldName)

Deprecated. As of Sitevision 3.0 this method will always return null. Do not use this interface at all, it will be completely removed in future releases of Sitevision.

Returns a highlighted fragment for a specified field.

Parameters:

aHighlightPreElement - the opening element to the left of a highlighted word(-s), e.g "<strong style=\"background-color:yellow\">"

aHighlightPostElement - the closing element to the right of a highlighted word(-s), e.g "</strong>"

aSearchHit - the search hit that should be highlighted

aHighlightingFieldName - the field that should be highlighted. A default field will be used if aHighlightingFieldName is null. The field that with most characters will be used if multiple fields match. Binary fields are ignored.

Returns:

a highlighted text fragment with all matches surrounded with aHighlightPreElement and aHighlightPostElement, null if nothing could be highlighted