org.hibernate.search.engine.cfg

Class IndexSettings

java.lang.Object

org.hibernate.search.engine.cfg.IndexSettings

public final class IndexSettings
extends Object

Configuration properties common to all Hibernate Search indexes regardless of the underlying technology.

Constants in this class are to be appended to a prefix to form a property key. The exact prefix will depend on the integration, but should generally look like either "hibernate.search.backend.<backend name>.indexes.<index name>." (for per-index settings) or "hibernate.search.backends.<backend name>.index_defaults." (for default index settings).

Method Summary

Modifier and Type	Method and Description
static String	indexDefaultsKey(String backendName, String radical) Builds a configuration property key for the index defaults of the given backend, with the given radical.
static String	indexKey(String backendName, String indexName, String radical) Builds a configuration property key for the index of the given backend, with the given radical.

Methods inherited from class java.lang.Object

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

Method Detail

indexDefaultsKey

public static String indexDefaultsKey(String backendName,
                                      String radical)

Builds a configuration property key for the index defaults of the given backend, with the given radical.

See the javadoc of your backend for avalaible radicals.

Example result: "hibernate.search.backends.<backendName>.index_defaults.lifecycle.strategy"

Parameters:

backendName - Expect the backendName

radical - The radical of the configuration property (see constants in ElasticsearchIndexSettings, LuceneIndexSettings, etc.)

Returns:

the concatenated default index settings key

indexKey

public static String indexKey(String backendName,
                              String indexName,
                              String radical)

Builds a configuration property key for the index of the given backend, with the given radical.

See the javadoc of your backend for avalaible radicals.

Example result: "hibernate.search.backends.<backendName>.indexes.<indexName>.lifecycle.strategy"

Parameters:

backendName - Expect the backendName

indexName - Expect the specific targeted index name

radical - The radical of the configuration property (see constants in ElasticsearchIndexSettings, LuceneIndexSettings, etc.)

Returns:

the concatenated index settings key