org.hibernate.search.mapper.orm.cfg

Class HibernateOrmMapperSettings

java.lang.Object

org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings

public final class HibernateOrmMapperSettings
extends Object

Author:

Emmanuel Bernard, Hardy Ferentschik

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTOREGISTER_LISTENERS Whether Hibernate Search should automatically register listeners to entity changes, so that changes to entities result in automatic indexing.
static String	ENABLE_ANNOTATION_MAPPING Whether annotations should be automatically processed for entity types, as well as nested types in those entity types, for instance embedded types.
static String	ENABLE_CONFIGURATION_PROPERTY_TRACKING Whether usage of configuration property should be tracked.
static String	ENABLE_DIRTY_CHECK Whether to check if dirty properties are relevant to indexing before actually reindexing an entity.
static String	INDEXING_STRATEGY The indexing strategy to use.
static String	MAPPING_CONFIGURER The mapping configurer to use.
static String	PREFIX

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

ENABLE_CONFIGURATION_PROPERTY_TRACKING

public static final String ENABLE_CONFIGURATION_PROPERTY_TRACKING

Whether usage of configuration property should be tracked.

When enabled, Hibernate Search will track the parts of the provided configuration that are actually used and log a warning if any configuration property is never used, which might indicate a configuration issue.

Expects a Boolean value such as true or false, or a string that can be parsed to such Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.ENABLE_CONFIGURATION_PROPERTY_TRACKING.

See Also:

Constant Field Values

AUTOREGISTER_LISTENERS

public static final String AUTOREGISTER_LISTENERS

Whether Hibernate Search should automatically register listeners to entity changes, so that changes to entities result in automatic indexing.

Expects a Boolean value such as true or false, or a string that can be parsed to such Boolean value.

Defaults to HibernateOrmMapperSettings.Defaults.AUTOREGISTER_LISTENERS.

See Also:

Constant Field Values

INDEXING_STRATEGY

public static final String INDEXING_STRATEGY

The indexing strategy to use.

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

Defaults to HibernateOrmMapperSettings.Defaults.INDEXING_STRATEGY.

See Also:

Constant Field Values

ENABLE_DIRTY_CHECK

public static final String ENABLE_DIRTY_CHECK

Whether to check if dirty properties are relevant to indexing before actually reindexing an entity.

When enabled, re-indexing of an entity is skipped if the only changes are on properties that are not used when indexing. This feature is considered safe and thus enabled by default.

Expects a Boolean value such as true or false, or a string that can be parsed to such Boolean value.

Defaults to Defaults#ENABLE_DIRTY_CHECK.

See Also:

Constant Field Values

ENABLE_ANNOTATION_MAPPING

public static final String ENABLE_ANNOTATION_MAPPING

Whether annotations should be automatically processed for entity types, as well as nested types in those entity types, for instance embedded types.

Expects a Boolean value such as true or false, or a string that can be parsed to such Boolean value.

Defaults to Defaults#ENABLE_ANNOTATION_MAPPING.

See Also:

Constant Field Values

MAPPING_CONFIGURER

public static final String MAPPING_CONFIGURER

The mapping configurer to use.

Expects a reference to a bean of type HibernateOrmSearchMappingConfigurer.

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