com.illucit.instatrie.index

Interface PrefixIndex<T extends Serializable>

All Superinterfaces:

Serializable

All Known Subinterfaces:

PrefixIndexListDecorator<T>

All Known Implementing Classes:

TriePrefixIndex, TriePrefixIndex.TriePrefixIndexFiltered, TriePrefixIndex.TriePrefixIndexListDecorator, TriePrefixIndex.TriePrefixIndexListDecoratorFiltered

public interface PrefixIndex<T extends Serializable>
extends Serializable

Method Summary

Modifier and Type	Method and Description
void	createIndex(Collection<T> models) Create or recreate prefix index.
PrefixIndexListDecorator<T>	decorateAsList() Get an instance of PrefixIndex which also implements the List interface.
List<T>	getAll() Get all model entries in the index as list (in the same order they were in the collection iterator on index building).
PrefixIndex<T>	getFilteredView(Predicate<T> filterFunction) Get a view on the current prefix index which only returns models matching the given filter predicate.
HighlightedString	getHighlighted(String modelValue, String query) Highlight the hits from a prefix query in a model value String.
HighlightedString	getHighlightedHtml(String modelValue, String query) Highlight the hits from a prefix query in a model value String with HTML.
List<T>	search(String query) Search the index for a query string and return a list of indexed models, which match the query prefix criteria.
List<T>	search(String query, long maxSize) Search the index for a query string and return a list of indexed models, which match the query prefix criteria.
List<T>	searchExact(String query) Search the index for a query string and return a list of indexed models, which match the query criteria.
Stream<T>	searchStream(String query) Search the index for a query string and return a stream of indexed models, which match the query prefix criteria.

Method Detail

createIndex

void createIndex(Collection<T> models)

Create or recreate prefix index. Previously allocated indexes are cleared. The operation must be threadsafe, so the new index is switched as atomic operation (and other threads will have access to the old index until it is completely updated).

Parameters:

models - collection of models to index

searchStream

Stream<T> searchStream(String query)

Search the index for a query string and return a stream of indexed models, which match the query prefix criteria. The query string is splitted with the given search word splitter (the default search word splitter is extracting the query words by finding connected alphanumeric sequences). All query words must be found (completely or as prefixes) in the index for an entry to be considered found. The stream still requires a terminal operation in order to be processed.

Parameters:

query - query string

Returns:

list of models, in the same order or the iterator of the indexed collection

search

List<T> search(String query)

Search the index for a query string and return a list of indexed models, which match the query prefix criteria. The query string is splitted with the given search word splitter (the default search word splitter is extracting the query words by finding connected alphanumeric sequences). All query words must be found (completely or as prefixes) in the index for an entry to be considered found.

Parameters:

query - query string

Returns:

list of models, in the same order or the iterator of the indexed collection

search

List<T> search(String query,
               long maxSize)

Search the index for a query string and return a list of indexed models, which match the query prefix criteria. The query string is splitted with the given search word splitter (the default search word splitter is extracting the query words by finding connected alphanumeric sequences). All query words must be found (completely or as prefixes) in the index for an entry to be considered found. If there are more entries found than the parameter limit, all remaining are omitted from the result list.

Parameters:

query - query string

maxSize - as soon as there are so many entries found, all others are omitted

Returns:

list of models, in the same order or the iterator of the indexed collection

searchExact

List<T> searchExact(String query)

Search the index for a query string and return a list of indexed models, which match the query criteria. The query string is splitted with the given search word splitter (the default search word splitter is extracting the query words by finding connected alphanumeric sequences). All query words must be found completely in the index for an entry to be considered found.

Parameters:

query - query string

Returns:

list of models, in the same order or the iterator of the indexed collection

getAll

List<T> getAll()

Get all model entries in the index as list (in the same order they were in the collection iterator on index building).

Returns:

list of models

getHighlighted

HighlightedString getHighlighted(String modelValue,
                                 String query)

Highlight the hits from a prefix query in a model value String.

Parameters:

modelValue - value to resolve highlights from

query - query string with prefixes to be highlighted

Returns:

highlighted String

getHighlightedHtml

HighlightedString getHighlightedHtml(String modelValue,
                                     String query)

Highlight the hits from a prefix query in a model value String with HTML.

Parameters:

modelValue - value to resolve highlights from (with HTML tags)

query - query string with prefixes to be highlighted

Returns:

highlighted String

decorateAsList

PrefixIndexListDecorator<T> decorateAsList()

Get an instance of PrefixIndex which also implements the List interface. The returned instance is completely entangled with the current object, so that both objects share a state and each trie operation on one of the objects also affects the other object in the same way.

Returns:

decorated prefix index

getFilteredView

PrefixIndex<T> getFilteredView(Predicate<T> filterFunction)

Get a view on the current prefix index which only returns models matching the given filter predicate. The returned instance is completely entangled with the current object, so that both objects share a state and each trie operation on one of the objects also affects the other object in the same way. The original prefix index won't be modified by this operation. If the current instance already contins a filter, the new predicate will be added as additional filter predicate.

Parameters:

filterFunction - filter function to filter search stream

Returns:

decorated prefix index