de.espirit.firstspirit.client.access.editor

Interface ReferenceAwareValueIndexSupporting<T>

Type Parameters:

T - Value type, same as in ValueEngineer

public interface ReferenceAwareValueIndexSupporting<T>

Aspect for ValueEngineers supporting reference-aware indexing and full text searching.

Implementors must appendIndexData(ValueIndexer, Object, boolean) provide indexing data} for values.

Since:

5.0.100

Field Summary

Fields

Modifier and Type	Field and Description
static ValueEngineerAspectType<ReferenceAwareValueIndexSupporting<?>>	TYPE Aspect for ValueEngineers supporting recursion-aware indexing and full text searching.

Method Summary

Methods

Modifier and Type	Method and Description
void	appendIndexData(ValueIndexer indexer, T value, boolean includeReferences) Asks to append indexing data for the given value to the handed indexer.

Field Detail

TYPE

static final ValueEngineerAspectType<ReferenceAwareValueIndexSupporting<?>> TYPE

Aspect for ValueEngineers supporting recursion-aware indexing and full text searching.

Since:

5.0.100

Method Detail

appendIndexData

void appendIndexData(@NotNull
                   ValueIndexer indexer,
                   @NotNull
                   T value,
                   boolean includeReferences)

Asks to append indexing data for the given value to the handed indexer. If the request is flagged to include references, data of referenced elements should be included in the indexing process, otherwise, a (simplified textual) representation of their values may be added.

Parameters:

indexer - The indexer to append to.

value - The value to append data for.

includeReferences - Indicates to recursively collect data in case of referenced elements.

Since:

5.0.100