com.illucit.instatrie.splitter

Class StringWordSplitter<T>

java.lang.Object

com.illucit.instatrie.splitter.StringWordSplitter<T>

Type Parameters:

T - model type

All Implemented Interfaces:

SubwordHighlighter, WordSplitter<T>

Direct Known Subclasses:

StringWordSplitter.IdentityStringWordSplitter

public class StringWordSplitter<T>
extends Object
implements WordSplitter<T>, SubwordHighlighter

Implementation of a WordSplitter which uses a regular expression to extract subwords. All string values will be normalized to lower case. Also normalization of unicode characters to their ASCII value (like ä to a) is enabled by default.

This splitter class also implements SubwordHighlighter and can therefore be used for highlighting query words in a model string

Author:

Christian Simon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringWordSplitter.IdentityStringWordSplitter StringWordSplitter implementation for String models which use the complete String data as source for the word splitter.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	DEFAULT_SUBWORD_PATTERN
static Pattern	SIMPLE_TAG_PATTERN

Constructor Summary

Constructors

Constructor and Description
StringWordSplitter(Function<T,String> resolveIndexString) Create new string word splitter with default subword pattern.
StringWordSplitter(Function<T,String> resolveIndexString, String subwordPattern, boolean normalizeUnicode) Create new string word splitter.

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.
Set<String>	split(T data) Split the data of a model to a set of search words that identify the model for searching in a search index. if null is returned, the model won't be indexed.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SUBWORD_PATTERN

public static final Pattern DEFAULT_SUBWORD_PATTERN

SIMPLE_TAG_PATTERN

public static final Pattern SIMPLE_TAG_PATTERN

Constructor Detail

StringWordSplitter

public StringWordSplitter(Function<T,String> resolveIndexString)

Create new string word splitter with default subword pattern. Unicode normalization is performed.

Parameters:

resolveIndexString - transformation function get get the indexable string from a model instance

StringWordSplitter

public StringWordSplitter(Function<T,String> resolveIndexString,
                          String subwordPattern,
                          boolean normalizeUnicode)

Create new string word splitter.

Parameters:

resolveIndexString - transformation function get the indexable string from a model instance

subwordPattern - pattern to identify groups or characters to index as individual words (if null is given, the default alphanumeric subword pattern is used)

normalizeUnicode - flag, if unicode special characters whould be normalized to ASCII, if possible

Method Detail

split

public Set<String> split(T data)

Description copied from interface: WordSplitter

Split the data of a model to a set of search words that identify the model for searching in a search index. if null is returned, the model won't be indexed.

Specified by:

split in interface WordSplitter<T>

Parameters:

data - model data

Returns:

set of search strings or null

highlightSubwordPrefixes

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

Description copied from interface: SubwordHighlighter

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

Specified by:

highlightSubwordPrefixes in interface SubwordHighlighter

Parameters:

value - value String to split and transform

queryWords - query words to highlight in prefixes

Returns:

highlighted String

highlightSubwordPrefixesWithHtml

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

Description copied from interface: SubwordHighlighter

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

Specified by:

highlightSubwordPrefixesWithHtml in interface SubwordHighlighter

Parameters:

value - value HTML String to split and transform

queryWords - query words to highlight in prefixes

Returns:

highlighted String