de.espirit.firstspirit.access.editor
Interface ValueIndexer

public interface ValueIndexer

An indexer on field based values.

Additionally provides constants of common field names. The usage of these names is not compulsory, but will ensure a better usability for drill down and search refinement purposes.

Since:

4.2.427

Field Summary

static String	KEY_FIELD Field name for language independent information representing the value.
static String	VALUE_FIELD Field name for language dependent information representing the value.

Method Summary

void	append(String name, String value) Appends the given textual value for indexing with respect to the defined field name.

Field Detail

KEY_FIELD

static final String KEY_FIELD

Field name for language independent information representing the value.

Note: Values appended as "key" will additionally be appended to a generic indexing field eligible for the standard field-based search.

Since:

4.2.427

See Also:

Constant Field Values

VALUE_FIELD

static final String VALUE_FIELD

Field name for language dependent information representing the value.

Note: Values appended as "value" will additionally be appended to a generic indexing field eligible for the standard field-based search.

Since:

4.2.427

See Also:

Constant Field Values

Method Detail

append

void append(@NotNull
            String name,
            @Nullable
            String value)

Appends the given textual value for indexing with respect to the defined field name. To make a field eligible for standard field-based search, make use of the related field names for keys and values.

Parameters:

name - The name to append the value for.

value - The value to be appended.

Since:

4.2.427

See Also:

ValueIndexer.KEY_FIELD, ValueIndexer.VALUE_FIELD