net.lenni0451.commons.strings.search

Class SearchEngine<T>

java.lang.Object

net.lenni0451.commons.strings.search.SearchEngine<T>

public class SearchEngine<T>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SearchEngine(java.util.function.Supplier<? extends java.lang.Iterable<T>> supplier, java.util.function.Function<T,java.lang.String> toStringFunction)

Method Summary

Modifier and Type	Method and Description
SearchResult<T>	search(ResultFilter filter, java.lang.String query) Searches for objects in the supplier that match the given query.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchEngine

public SearchEngine(java.util.function.Supplier<? extends java.lang.Iterable<T>> supplier,
                    java.util.function.Function<T,java.lang.String> toStringFunction)

Method Detail

search

public SearchResult<T> search(ResultFilter filter,
                              java.lang.String query)

Searches for objects in the supplier that match the given query.
The query can contain:

• Keywords: Words that are separated by spaces
• Required Words: Words that are surrounded by single or double quotes
• OR: The keyword OR to combine two keywords with a binary or operator

Parameters:

filter - The filter that should be applied to the results

query - The query to search for

Returns:

The search result containing the results and metadata