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 and Description
static class	LuceneBackendSettings.Defaults Default values for the different settings if no values are given.
static class	LuceneBackendSettings.DirectoryRadicals Configuration property keys for directories without the prefix.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANALYSIS_CONFIGURER The analysis configurer to use.
static String	DIRECTORY_FILESYSTEM_ACCESS_STRATEGY The filesystem access strategy for directories.
static String	DIRECTORY_LOCKING_STRATEGY The locking strategy for directories.
static String	DIRECTORY_PREFIX The prefix for directory-related property keys.
static String	DIRECTORY_ROOT The filesystem root for directories.
static String	DIRECTORY_TYPE The type of directory to use when reading from or writing to the index.
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	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.

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

public static final String DIRECTORY_PREFIX

The prefix for directory-related property keys.

See Also:

Constant Field Values

DIRECTORY_TYPE

public static final String DIRECTORY_TYPE

The type of directory to use when reading from or writing to the index.

Expects a String, such as "local-filesystem". See the reference documentation for a list of available values.

Defaults to LuceneBackendSettings.Defaults.DIRECTORY_TYPE.

See Also:

Constant Field Values

DIRECTORY_ROOT

public static final String DIRECTORY_ROOT

The filesystem root for directories.

Only available for the "local-filesystem" directory type.

Expects a String representing a path to an existing directory accessible in read and write mode, such as "local-filesystem".

The actual index files will be created in <root>/<index name>.

Defaults to the JVM's working directory (LuceneBackendSettings.Defaults.DIRECTORY_ROOT).

See Also:

Constant Field Values

DIRECTORY_LOCKING_STRATEGY

public static final String DIRECTORY_LOCKING_STRATEGY

The locking strategy for directories.

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

Defaults are specific to each directory type.

See Also:

Constant Field Values

DIRECTORY_FILESYSTEM_ACCESS_STRATEGY

public static final String DIRECTORY_FILESYSTEM_ACCESS_STRATEGY

The filesystem access strategy for directories.

Only available for the "local-filesystem" directory type.

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

Defaults to LuceneBackendSettings.Defaults.DIRECTORY_FILESYSTEM_ACCESS_STRATEGY.

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