Package de.cxp.ocs.config

Class SearchConfiguration

java.lang.Object

de.cxp.ocs.config.SearchConfiguration

public class SearchConfiguration
extends Object

Final search-configuration that contains all the fetched configuration objects.

Constructor Summary

Constructors

Constructor	Description
SearchConfiguration()

Method Summary

Modifier and Type	Method	Description
SearchConfiguration	addPluginConfiguration(@NonNull String pluginClassName, @NonNull Map<String,String> pluginConfig)	Settings for the single possible customization classes, like rescorers, query analyzers etc.
SearchConfiguration	setFacetConfiguration(@NonNull FacetConfiguration facetConfiguration)	Optional facet configuration to customize the way the facets should be displayed.
SearchConfiguration	setIndexName(String indexName)	Optional index-name that should be addressed by the tenant.
SearchConfiguration	setQueryConfigs(@NonNull List<QueryConfiguration> queryConfigs)	Get query relaxation chain.
SearchConfiguration	setQueryProcessing(@NonNull QueryProcessingConfiguration queryProcessing)	Optional query processing configuration.
SearchConfiguration	setRescorers(@NonNull List<String> rescorers)	List of full canonical class names of the RescorerProvider that should activated for the according tenant.
SearchConfiguration	setScoring(@NonNull ScoringConfiguration scoring)	Optional scoring configuration.
SearchConfiguration	setSortConfigs(@NonNull List<SortOptionConfiguration> sortConfigs)	Specific which sorting option should be part of result.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchConfiguration

public SearchConfiguration()

Method Detail

setIndexName

public SearchConfiguration setIndexName(String indexName)

Optional index-name that should be addressed by the tenant. If null, the index name will be set to the tenant name.

Parameters:

tenant -

Returns:

config again for fluent access

setQueryProcessing

public SearchConfiguration setQueryProcessing(@NonNull
                                              @NonNull QueryProcessingConfiguration queryProcessing)

Optional query processing configuration. If nothing special is defined, the standard behavior will be used.

Parameters:

queryProcessing -

Returns:

config again for fluent access

setFacetConfiguration

public SearchConfiguration setFacetConfiguration(@NonNull
                                                 @NonNull FacetConfiguration facetConfiguration)

Optional facet configuration to customize the way the facets should be displayed.

If default/empty, facets will be generated according to default settings.

Parameters:

tenant -

Returns:

config again for fluent access

setScoring

public SearchConfiguration setScoring(@NonNull
                                      @NonNull ScoringConfiguration scoring)

Optional scoring configuration.

If set to default (empty), no scoring rules will be applied at all.

Parameters:

tenant -

Returns:

config again for fluent access

setRescorers

public SearchConfiguration setRescorers(@NonNull
                                        @NonNull List<String> rescorers)

List of full canonical class names of the RescorerProvider that should activated for the according tenant.

Use the 'pluginConfiguration' setting to add custom configuration for the activated rescorers.

Per defaults it's empty, so no rescorers are used.

Parameters:

rescorers -

Returns:

config again for fluent access

setQueryConfigs

public SearchConfiguration setQueryConfigs(@NonNull
                                           @NonNull List<QueryConfiguration> queryConfigs)

Get query relaxation chain. If empty, only the DefaultQueryBuilder will be used.

Parameters:

queryConfigs -

Returns:

config again for fluent access

setSortConfigs

public SearchConfiguration setSortConfigs(@NonNull
                                          @NonNull List<SortOptionConfiguration> sortConfigs)

Specific which sorting option should be part of result.

If list is empty, all possible sorting options will be delivered in default style according to indexed sorting fields.

Parameters:

sortConfigs -

Returns:

config again for fluent access

addPluginConfiguration

public SearchConfiguration addPluginConfiguration(@NonNull
                                                  @NonNull String pluginClassName,
                                                  @NonNull
                                                  @NonNull Map<String,String> pluginConfig)

Settings for the single possible customization classes, like rescorers, query analyzers etc.

As a key the full canonical class name of the customization class is expected.

The value is an optional string-to-string map with arbitrary settings for the according customization class that will be passed to it with the "initialize" method.

Check the java-doc of the according classes for more details.

Parameters:

pluginClassName -

pluginConfig -

Returns:

config again for fluent access