Package de.cxp.ocs.smartsuggest.spi.standard

Class DefaultSuggestConfigProvider

java.lang.Object

de.cxp.ocs.smartsuggest.spi.standard.DefaultSuggestConfigProvider

All Implemented Interfaces:

SuggestConfigProvider

public class DefaultSuggestConfigProvider
extends Object
implements SuggestConfigProvider

Constructor Summary

Constructors

Constructor	Description
DefaultSuggestConfigProvider()
DefaultSuggestConfigProvider(@NonNull SuggestConfig defaultSuggestConfig)

Method Summary

Modifier and Type	Method	Description
SuggestConfig	getConfig(@NonNull String indexName, SuggestConfig indexConfig)	Retrieve config for a given index.
int	getPriority()	Return priority when this config provider should be asked for the configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultSuggestConfigProvider

public DefaultSuggestConfigProvider()

DefaultSuggestConfigProvider

public DefaultSuggestConfigProvider(@NonNull
 @NonNull SuggestConfig defaultSuggestConfig)

Method Details

getConfig

public SuggestConfig getConfig(@NonNull
 @NonNull String indexName,
 SuggestConfig indexConfig)

Description copied from interface: SuggestConfigProvider

Retrieve config for a given index. In case only some index specific values should be set, the default suggest config can be used since it may contain global settings (if not null).

Specified by:

getConfig in interface SuggestConfigProvider

Parameters:

indexName -

indexConfig - copy of the suggest config that was set as default for the whole service. It can be modified and returned or a different config object can be returned. Returning null is considered equivalent to returning that default config.

Returns:

getPriority

public int getPriority()

Description copied from interface: SuggestConfigProvider

Return priority when this config provider should be asked for the configuration. Providers with a low priority value (e.g. 1) will be asked first and providers with a higher value will be called later and can overwrite previously set values.

Specified by:

getPriority in interface SuggestConfigProvider

Returns:

priority value, defaults to 100