Package org.hibernate.search.backend.lucene.cfg

Class LuceneBackendSettings

java.lang.Object

org.hibernate.search.backend.lucene.cfg.LuceneBackendSettings

public final class LuceneBackendSettings
extends Object

Configuration properties for Lucene backends.

Constants in this class are to be appended to a prefix to form a property key; see BackendSettings for details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LuceneBackendSettings.Defaults	Default values for the different settings if no values are given.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANALYSIS_CONFIGURER	The configurer for analysis.
static final String	LUCENE_VERSION	The Lucene version to passed to analyzers when they are created.
static final String	MULTI_TENANCY_STRATEGY	How to implement multi-tenancy.
static final String	QUERY_CACHING_CONFIGURER	The configurer for query caching.
static final String	SCHEMA_ID_STRATEGY	Strategy that defines how to read/write IDs to/from a document.
static final String	THREAD_POOL_SIZE	The size of the thread pool assigned to the backend.
static final String	TYPE_NAME	The value to set the backend type configuration property to in order to get a Lucene backend instantiated by Hibernate Search.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

TYPE_NAME

public static final String TYPE_NAME

The value to set the backend type configuration property to in order to get a Lucene backend instantiated by Hibernate Search.

Only useful if you have more than one backend technology in the classpath; otherwise the backend type is automatically detected.

See Also:

• Constant Field Values

LUCENE_VERSION

public static final String LUCENE_VERSION

The Lucene version to passed to analyzers when they are created.

This should be set in order to get consistent behavior when Lucene is upgraded.

Expects a Lucene Version object, or a String accepted by Version.parseLeniently(java.lang.String)

Defaults to LuceneBackendSettings.Defaults.LUCENE_VERSION, which may change when Hibernate Search or Lucene is upgraded, and therefore does not offer any backwards-compatibility guarantees. The recommended approach is to set this property explicitly to the version of Lucene you want to target.

See Also:

• Constant Field Values

MULTI_TENANCY_STRATEGY

public static final String MULTI_TENANCY_STRATEGY

How to implement multi-tenancy.

Expects a MultiTenancyStrategyName value, or a String representation of such value.

Defaults to LuceneBackendSettings.Defaults.MULTI_TENANCY_STRATEGY.

See Also:

• Constant Field Values

ANALYSIS_CONFIGURER

public static final String ANALYSIS_CONFIGURER

The configurer for analysis.

Expects a single-valued or multi-valued reference to beans of type LuceneAnalysisConfigurer.

Defaults to no value.

See Also:

• The core documentation of configuration properties, which includes a description of the "multi-valued bean reference" properties and accepted values.
• Constant Field Values

QUERY_CACHING_CONFIGURER

public static final String QUERY_CACHING_CONFIGURER

The configurer for query caching.

Expects a single-valued or multi-valued reference to beans of type QueryCachingConfigurer.

Defaults to no value.

See Also:

• The core documentation of configuration properties, which includes a description of the "multi-valued bean reference" properties and accepted values.
• Constant Field Values

THREAD_POOL_SIZE

public static final String THREAD_POOL_SIZE

The size of the thread pool assigned to the backend.

Expects a strictly positive integer value, or a string that can be parsed into an integer value.

See the reference documentation, section "Lucene backend - Threads", for more information about this setting and its implications.

Defaults to the number of processor cores available to the JVM on startup.

See Also:

• Constant Field Values

SCHEMA_ID_STRATEGY

public static final String SCHEMA_ID_STRATEGY

Strategy that defines how to read/write IDs to/from a document.

Expects a SchemaIdStrategy value, or a String representation of such value.

Defaults to LuceneBackendSettings.Defaults.SCHEMA_ID_STRATEGY.

See Also:

• Constant Field Values