Package sonia.scm.search

Interface Index<T>

Type Parameters:

T - type of indexed objects

@Beta
public interface Index<T>

Can be used to index objects for full text searches.

Since:

2.21.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Index.DeleteBy	Builder api to delete all objects which match parts of their id.
static interface	Index.Deleter<T>	Deleter provides an api to delete object from index.

Method Summary

Modifier and Type	Method	Description
Index.Deleter<T>	delete()	Delete provides an api to delete objects from the index
IndexDetails	getDetails()	Returns details such as name and type of index.
void	store(Id<T> id, String permission, T object)	Store the given object in the index.

Method Details

getDetails

IndexDetails getDetails()

Returns details such as name and type of index.

Since:

2.23.0

store

void store(Id<T> id,
 String permission,
 T object)

Store the given object in the index. All fields of the object annotated with Indexed will be stored in the index.

Parameters:

id - identifier of the object in the index

permission - Shiro permission string representing the required permission to see this object as a result

object - object to index

See Also:

• Indexed

delete

Index.Deleter<T> delete()

Delete provides an api to delete objects from the index

Returns:

delete api

Since:

2.23.0