com.illucit.instatrie.splitter

Interface SubwordHighlighter

All Known Implementing Classes:

StringWordSplitter, StringWordSplitter.IdentityStringWordSplitter, TriePrefixIndex, TriePrefixIndex.TriePrefixIndexFiltered, TriePrefixIndex.TriePrefixIndexListDecorator, TriePrefixIndex.TriePrefixIndexListDecoratorFiltered

public interface SubwordHighlighter

Interface for classes which are capable of splitting a value String into a highlighted string by locating all prefix matches inside

Author:

Christian Simon

Method Summary

Modifier and Type	Method and Description
HighlightedString	highlightSubwordPrefixes(String value, Set<String> queryWords) Search value String for prefixes in query words and highlight in original String.
HighlightedString	highlightSubwordPrefixesWithHtml(String value, Set<String> queryWords) Search value String (with HTML tags) for prefixes in query words and highlight in original String.

Method Detail

highlightSubwordPrefixes

HighlightedString highlightSubwordPrefixes(String value,
                                           Set<String> queryWords)

Search value String for prefixes in query words and highlight in original String.

Parameters:

value - value String to split and transform

queryWords - query words to highlight in prefixes

Returns:

highlighted String

highlightSubwordPrefixesWithHtml

HighlightedString highlightSubwordPrefixesWithHtml(String value,
                                                   Set<String> queryWords)

Search value String (with HTML tags) for prefixes in query words and highlight in original String.

Parameters:

value - value HTML String to split and transform

queryWords - query words to highlight in prefixes

Returns:

highlighted String