com.illucit.instatrie.index

Class TriePrefixIndex.TriePrefixIndexFiltered<T extends Serializable>

java.lang.Object

com.illucit.instatrie.index.TriePrefixIndex<T>

com.illucit.instatrie.index.TriePrefixIndex.TriePrefixIndexFiltered<T>

Type Parameters:

T - model type

All Implemented Interfaces:

PrefixIndex<T>, SubwordHighlighter, Serializable

Direct Known Subclasses:

TriePrefixIndex.TriePrefixIndexListDecoratorFiltered

Enclosing class:

TriePrefixIndex<T extends Serializable>

public static class TriePrefixIndex.TriePrefixIndexFiltered<T extends Serializable>
extends TriePrefixIndex<T>

View on a TriePrefixIndex where all result lists are filtered by a target predicate function. The internal data structures are completely entangled with the given dalagate trie prefix index, so the state is share across both instances.

Author:

Christian Simon

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.illucit.instatrie.index.TriePrefixIndex

TriePrefixIndex.TriePrefixIndexFiltered<T extends Serializable>, TriePrefixIndex.TriePrefixIndexListDecorator<T extends Serializable>, TriePrefixIndex.TriePrefixIndexListDecoratorFiltered<T extends Serializable>

Constructor Summary

Constructors

Constructor and Description
TriePrefixIndexFiltered(TriePrefixIndex.TriePrefixIndexFiltered<T> delegate, Predicate<T> additionalFilterFunction) Upgrade from TriePrefixIndex.TriePrefixIndexFiltered with an additional filter predicate.
TriePrefixIndexFiltered(TriePrefixIndex<T> delegate, Predicate<T> filterFunction) Upgrade from common prefix index.

Method Summary

Modifier and Type	Method and Description
TriePrefixIndex.TriePrefixIndexListDecoratorFiltered<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).
TriePrefixIndex.TriePrefixIndexFiltered<T>	getFilteredView(Predicate<T> filterFunction) Get a view on the current prefix index which only returns models matching the given filter predicate.
Predicate<T>	getFilterFunction() Get the filter predicate used by this view.
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.

Methods inherited from class com.illucit.instatrie.index.TriePrefixIndex

createIndex, getHighlighted, getHighlightedHtml, highlightSubwordPrefixes, highlightSubwordPrefixesWithHtml, search, search, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TriePrefixIndexFiltered

public TriePrefixIndexFiltered(TriePrefixIndex<T> delegate,
                               Predicate<T> filterFunction)

Upgrade from common prefix index.

Parameters:

delegate - prefix index delegate

filterFunction - filter predicate

TriePrefixIndexFiltered

public TriePrefixIndexFiltered(TriePrefixIndex.TriePrefixIndexFiltered<T> delegate,
                               Predicate<T> additionalFilterFunction)

Upgrade from TriePrefixIndex.TriePrefixIndexFiltered with an additional filter predicate.

Parameters:

delegate - prefix index delegate

additionalFilterFunction - additional filter predicate

Method Detail

getFilterFunction

public Predicate<T> getFilterFunction()

Get the filter predicate used by this view.

Returns:

filter method

getAll

public List<T> getAll()

Description copied from interface: PrefixIndex

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

Specified by:

getAll in interface PrefixIndex<T extends Serializable>

Overrides:

getAll in class TriePrefixIndex<T extends Serializable>

Returns:

list of models

searchStream

public Stream<T> searchStream(String query)

Description copied from interface: PrefixIndex

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.

Specified by:

searchStream in interface PrefixIndex<T extends Serializable>

Overrides:

searchStream in class TriePrefixIndex<T extends Serializable>

Parameters:

query - query string

Returns:

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

searchExact

public List<T> searchExact(String query)

Description copied from interface: PrefixIndex

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.

Specified by:

searchExact in interface PrefixIndex<T extends Serializable>

Overrides:

searchExact in class TriePrefixIndex<T extends Serializable>

Parameters:

query - query string

Returns:

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

decorateAsList

public TriePrefixIndex.TriePrefixIndexListDecoratorFiltered<T> decorateAsList()

Description copied from interface: PrefixIndex

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.

Specified by:

decorateAsList in interface PrefixIndex<T extends Serializable>

Overrides:

decorateAsList in class TriePrefixIndex<T extends Serializable>

Returns:

decorated prefix index

getFilteredView

public TriePrefixIndex.TriePrefixIndexFiltered<T> getFilteredView(Predicate<T> filterFunction)

Description copied from interface: PrefixIndex

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.

Specified by:

getFilteredView in interface PrefixIndex<T extends Serializable>

Overrides:

getFilteredView in class TriePrefixIndex<T extends Serializable>

Parameters:

filterFunction - filter function to filter search stream

Returns:

decorated prefix index