TriePrefixIndex (InstaTrie 1.5 API)

java.lang.Object
- com.illucit.instatrie.index.TriePrefixIndex<T>

Type Parameters:

T - model type

All Implemented Interfaces:

PrefixIndex<T>, SubwordHighlighter, Serializable

Direct Known Subclasses:

TriePrefixIndex.TriePrefixIndexFiltered, TriePrefixIndex.TriePrefixIndexListDecorator
```
public class TriePrefixIndex<T extends Serializable>
extends Object
implements PrefixIndex<T>, SubwordHighlighter
```
Data structure to manage a collection of data objects and allow to find entries from the collection efficiently with prefix search strings. The data structure is designed to be filled once and then only be queried.

Author:

Christian Simon

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TriePrefixIndex.TriePrefixIndexFiltered<T extends Serializable>` View on a `TriePrefixIndex` where all result lists are filtered by a target predicate function.
`static class`	`TriePrefixIndex.TriePrefixIndexListDecorator<T extends Serializable>` Decorator implementation of `PrefixIndexListDecorator` for `TriePrefixIndex`.
`static class`	`TriePrefixIndex.TriePrefixIndexListDecoratorFiltered<T extends Serializable>` Decorator implementation of `PrefixIndexListDecorator` for `TriePrefixIndex.TriePrefixIndexFiltered`.

Constructor Summary

Constructors
Constructor and Description
`TriePrefixIndex(Function<T,String> stringSplitterFunction)` Create prefix index with default query splitter.
`TriePrefixIndex(WordSplitter<T> dataWordSplitter)` Create prefix index with default query splitter.
`TriePrefixIndex(WordSplitter<T> dataWordSplitter, StringWordSplitter<String> searchWordSplitter)` Create prefix index.
`TriePrefixIndex(WordSplitter<T> dataWordSplitter, WordSplitter<String> searchWordSplitter, SubwordHighlighter highlighter)` Create prefix index.

Method Summary

All Methods Instance Methods Concrete Methods
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).
`TriePrefixIndex.TriePrefixIndexFiltered<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.
`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.
`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.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TriePrefixIndex
```
public TriePrefixIndex(Function<T,String> stringSplitterFunction)
```
    Create prefix index with default query splitter.
    
    Parameters:
    
    stringSplitterFunction - splitter function to get a search String from a model instance
  - TriePrefixIndex
```
public TriePrefixIndex(WordSplitter<T> dataWordSplitter)
```
    Create prefix index with default query splitter.
    
    Parameters:
    
    dataWordSplitter - splitter function to get a set of search words from a model instance
  - TriePrefixIndex
```
public TriePrefixIndex(WordSplitter<T> dataWordSplitter,
                       StringWordSplitter<String> searchWordSplitter)
```
    Create prefix index.
    
    Parameters:
    
    dataWordSplitter - splitter function to get a set of search words from a model instance
    
    searchWordSplitter - splitter function to get query words from a query string adn also for highlighting
  - TriePrefixIndex
```
public TriePrefixIndex(WordSplitter<T> dataWordSplitter,
                       WordSplitter<String> searchWordSplitter,
                       SubwordHighlighter highlighter)
```
    Create prefix index.
    
    Parameters:
    
    dataWordSplitter - splitter function to get a set of search words from a model instance
    
    searchWordSplitter - splitter function to get query words from a query string
    
    highlighter - highlighter for highlighting of matches prefixes
- Method Detail
  - createIndex
```
public void createIndex(Collection<T> models)
```
    Description copied from interface: PrefixIndex
    
    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).
    
    Specified by:
    
    createIndex in interface PrefixIndex<T extends Serializable>
    
    Parameters:
    
    models - collection of models to index
  - 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>
    
    Parameters:
    
    query - query string
    
    Returns:
    
    list of models, in the same order or the iterator of the indexed collection
  - search
```
public List<T> search(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 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.
    
    Specified by:
    
    search in interface PrefixIndex<T extends Serializable>
    
    Parameters:
    
    query - query string
    
    Returns:
    
    list of models, in the same order or the iterator of the indexed collection
  - search
```
public List<T> search(String query,
                      long maxSize)
```
    Description copied from interface: PrefixIndex
    
    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.
    
    Specified by:
    
    search in interface PrefixIndex<T extends Serializable>
    
    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
```
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>
    
    Parameters:
    
    query - query string
    
    Returns:
    
    list of models, in the same order or the iterator of the indexed collection
  - 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>
    
    Returns:
    
    list of models
  - getHighlighted
```
public HighlightedString getHighlighted(String modelValue,
                                        String query)
```
    Description copied from interface: PrefixIndex
    
    Highlight the hits from a prefix query in a model value String.
    
    Specified by:
    
    getHighlighted in interface PrefixIndex<T extends Serializable>
    
    Parameters:
    
    modelValue - value to resolve highlights from
    
    query - query string with prefixes to be highlighted
    
    Returns:
    
    highlighted String
  - getHighlightedHtml
```
public HighlightedString getHighlightedHtml(String modelValue,
                                            String query)
```
    Description copied from interface: PrefixIndex
    
    Highlight the hits from a prefix query in a model value String with HTML.
    
    Specified by:
    
    getHighlightedHtml in interface PrefixIndex<T extends Serializable>
    
    Parameters:
    
    modelValue - value to resolve highlights from (with HTML tags)
    
    query - query string with prefixes to be highlighted
    
    Returns:
    
    highlighted String
  - decorateAsList
```
public PrefixIndexListDecorator<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>
    
    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>
    
    Parameters:
    
    filterFunction - filter function to filter search stream
    
    Returns:
    
    decorated prefix index
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TriePrefixIndex<T extends Serializable>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TriePrefixIndex

TriePrefixIndex

TriePrefixIndex

TriePrefixIndex

Method Detail

createIndex

searchStream

search

search

searchExact

getAll

getHighlighted

getHighlightedHtml

decorateAsList

getFilteredView

highlightSubwordPrefixes

highlightSubwordPrefixesWithHtml

toString