Package ch.tocco.nice2.enterprisesearch.api.indexing

Interface IndexExtractor

All Known Implementing Classes:

DefaultEntityFieldIndexExtractor, DefaultEntityIndexExtractor, PageIndexExtractor, SearchConfigEntityIndexExtractor

public interface IndexExtractor

Index extractors can be contributed per entity type. The result of the first extractor who returns a non-null result will be taken for indexing. Index extractors can also be overwritten (by using the "before" or "after" attribute).

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INDEX_EXTRACTOR_ORDER

Method Summary

Modifier and Type	Method	Description
default @Nullable Map<String,Object>	extract(Entity entity)	If result is not null, it will be taken for indexing.
@Nullable Map<String,Object>	extract(Entity entity, FieldIndexExtractorFilter filter)	If result is not null, it will be taken for indexing.

Field Details

INDEX_EXTRACTOR_ORDER

static final int INDEX_EXTRACTOR_ORDER

See Also:

• Constant Field Values

Method Details

extract

@Nullable
default @Nullable Map<String,Object> extract(Entity entity)

If result is not null, it will be taken for indexing.

Parameters:

entity - Entity for extracting content.

Returns:

null if is not handled by the current extractor or an result if it's handled.

extract

@Nullable
@Nullable Map<String,Object> extract(Entity entity,
 FieldIndexExtractorFilter filter)

If result is not null, it will be taken for indexing.

Parameters:

entity - Entity for extracting content.

Returns:

null if is not handled by the current extractor or an result if it's handled.