Package sonia.scm.search

Interface SearchEngine

@Beta
public interface SearchEngine

The SearchEngine is the main entry point for indexing and searching.

Since:

2.21.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SearchEngine.ForIndices	Api for modifying multiple indices at once.
static interface	SearchEngine.ForType<T>	Search and index api.

Method Summary

Modifier and Type	Method	Description
SearchEngine.ForIndices	forIndices()	Returns an api which allows the modification of multiple indices at once.
<T> SearchEngine.ForType<T>	forType(Class<T> type)	Returns a type specific api which can be used to index objects of that specific type.
SearchEngine.ForType<Object>	forType(String name)	Returns an api which can be used to index and search object of that type.
Collection<SearchableType>	getSearchableTypes()	Returns a list of searchable types.

Method Details

getSearchableTypes

Collection<SearchableType> getSearchableTypes()

Returns a list of searchable types.

Returns:

collection of searchable types

forType

<T> SearchEngine.ForType<T> forType(Class<T> type)

Returns a type specific api which can be used to index objects of that specific type.

Type Parameters:

T - type of object

Parameters:

type - type of object

Returns:

type specific index and search api

Since:

2.23.0

forType

SearchEngine.ForType<Object> forType(String name)

Returns an api which can be used to index and search object of that type.

Parameters:

name - name of type

Returns:

search and index api

Since:

2.23.0

forIndices

SearchEngine.ForIndices forIndices()

Returns an api which allows the modification of multiple indices at once.

Returns:

api to modify multiple indices

Since:

2.23.0