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 class	LuceneBackendSettings.Defaults	Default values for the different settings if no values are given.
static class	LuceneBackendSettings.DirectoryRadicals	Deprecated. Use LuceneIndexSettings.DirectoryRadicals instead.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ANALYSIS_CONFIGURER	The analysis configurer to use.
static String	DIRECTORY_FILESYSTEM_ACCESS_STRATEGY	Deprecated. Use LuceneIndexSettings.DIRECTORY_FILESYSTEM_ACCESS_STRATEGY instead.
static String	DIRECTORY_LOCKING_STRATEGY	Deprecated. Use LuceneIndexSettings.DIRECTORY_LOCKING_STRATEGY instead.
static String	DIRECTORY_PREFIX	Deprecated. Use LuceneIndexSettings.DIRECTORY_PREFIX instead.
static String	DIRECTORY_ROOT	Deprecated. Use LuceneIndexSettings.DIRECTORY_ROOT instead.
static String	DIRECTORY_TYPE	Deprecated. Use LuceneIndexSettings.DIRECTORY_TYPE instead.
static String	LUCENE_VERSION	The Lucene version to passed to analyzers when they are created.
static String	MULTI_TENANCY_STRATEGY	The multi-tenancy strategy to use.
static String	THREAD_POOL_SIZE	The size of the thread pool assigned to the backend.
static String	TYPE_NAME	The name to use for the backend type configuration property so that a Lucene backend is 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 Detail

TYPE_NAME

public static final String TYPE_NAME

The name to use for the backend type configuration property so that a Lucene backend is 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 Version, 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 is really not a good choice. You really should set this property with your own value.

See Also:

Constant Field Values

DIRECTORY_PREFIX

@Deprecated
public static final String DIRECTORY_PREFIX

Deprecated.

Use LuceneIndexSettings.DIRECTORY_PREFIX instead.

See Also:

Constant Field Values

DIRECTORY_TYPE

@Deprecated
public static final String DIRECTORY_TYPE

Deprecated.

Use LuceneIndexSettings.DIRECTORY_TYPE instead.

See Also:

Constant Field Values

DIRECTORY_ROOT

@Deprecated
public static final String DIRECTORY_ROOT

Deprecated.

Use LuceneIndexSettings.DIRECTORY_ROOT instead.

See Also:

Constant Field Values

DIRECTORY_LOCKING_STRATEGY

@Deprecated
public static final String DIRECTORY_LOCKING_STRATEGY

Deprecated.

Use LuceneIndexSettings.DIRECTORY_LOCKING_STRATEGY instead.

See Also:

Constant Field Values

DIRECTORY_FILESYSTEM_ACCESS_STRATEGY

@Deprecated
public static final String DIRECTORY_FILESYSTEM_ACCESS_STRATEGY

Deprecated.

Use LuceneIndexSettings.DIRECTORY_FILESYSTEM_ACCESS_STRATEGY instead.

See Also:

Constant Field Values

MULTI_TENANCY_STRATEGY

public static final String MULTI_TENANCY_STRATEGY

The multi-tenancy strategy to use.

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 analysis configurer to use.

Expects a reference to a bean of type LuceneAnalysisConfigurer.

Defaults to no value.

See Also:

The core documentation of configuration properties, which includes a description of the "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 to such integer value.

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

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

See Also:

Constant Field Values