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

Fields

Modifier and Type	Field and Description
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

Methods

Modifier and Type	Method and Description
void	append(String name, String value) Appends the given textual value for indexing with respect to the defined field name.
void	appendDate(String name, Date value) Appends the given date value for indexing with respect to the defined field name.
void	appendNumber(String name, Number value) Appends the given number value for indexing with respect to the defined field name.
boolean	associate(Entity entity) Associate an entity with the value under indexing, so that if the entity changes, the value will be updated wrt. its index entry.

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:

KEY_FIELD, VALUE_FIELD

appendDate

void appendDate(@NotNull
              String name,
              @Nullable
              Date value)

Appends the given date value for indexing with respect to the defined field name. Will also forward to append(String,String) for storing a textual version of the date in a fixed format.

Parameters:

name - The name to append the value for.

value - The value to be appended.

Since:

5.0.100

appendNumber

void appendNumber(@NotNull
                String name,
                @Nullable
                Number value)

Appends the given number value for indexing with respect to the defined field name. Will also forward to append(String,String) for storing a textual version of the number.

Parameters:

name - The name to append the value for.

value - The value to be appended.

Since:

5.0.100

associate

boolean associate(@NotNull
                Entity entity)

Associate an entity with the value under indexing, so that if the entity changes, the value will be updated wrt. its index entry.

Parameters:

entity - The entity being associated with the value.

Returns:

true, if the entity was accepted for association.

Since:

4.2.427