de.espirit.firstspirit.client.access.editor

Interface MatchSupporting<T>

Type Parameters:

T - Value type, same as in ValueEngineer

public interface MatchSupporting<T>

Aspect for ValueEngineers supporting indexing and searching.

Implementors must transform a value to text for indexing and deliver a list of matches for a search request.

Since:

4.2.414

Field Summary

Fields

Modifier and Type	Field and Description
static ValueEngineerAspectType<MatchSupporting<?>>	TYPE Aspect for ValueEngineers supporting indexing and searching.

Method Summary

Methods

Modifier and Type	Method and Description
List<? extends Match>	getMatches(Request request, T value) Calculate a list of matches for a given request-value pair.
String	getStringForIndex(T value) Deprecated. since 4.2.427 - use the value indexing infrastructure instead.

Field Detail

TYPE

static final ValueEngineerAspectType<MatchSupporting<?>> TYPE

Aspect for ValueEngineers supporting indexing and searching.

Since:

4.2.414

Method Detail

getStringForIndex

@NotNull
@Deprecated
String getStringForIndex(@NotNull
                                          T value)

Deprecated. since 4.2.427 - use the value indexing infrastructure instead.

Transform the given value to text for indexing.

Parameters:

value - The value to transform.

Returns:

A textual representation for indexing purposes.

Since:

4.2.414

getMatches

@NotNull
List<? extends Match> getMatches(@NotNull
                                       Request request,
                                       @NotNull
                                       T value)

Calculate a list of matches for a given request-value pair.

Parameters:

request - The search request.

value - The value to search in.

Returns:

A list of search hits for the given request in the given value.

Since:

4.2.414