org.infinispan.configuration.cache

Class IndexingConfiguration

java.lang.Object

org.infinispan.commons.configuration.AbstractTypedPropertiesConfiguration

org.infinispan.configuration.cache.IndexingConfiguration

All Implemented Interfaces:

Matchable<IndexingConfiguration>, BaseConfigurationInfo, ConfigurationInfo

public class IndexingConfiguration
extends AbstractTypedPropertiesConfiguration
implements Matchable<IndexingConfiguration>, ConfigurationInfo

Configures indexing of entries in the cache for searching.

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeDefinition<Boolean>	AUTO_CONFIG
static AttributeDefinition<Boolean>	ENABLED
static AttributeDefinition<Index>	INDEX Deprecated. since 11.0
static AttributeDefinition<Set<String>>	INDEXED_ENTITIES
static AttributeDefinition<Map<Class<?>,Class<?>>>	KEY_TRANSFORMERS

Fields inherited from class org.infinispan.commons.configuration.AbstractTypedPropertiesConfiguration

attributes, PROPERTIES

Method Summary

Modifier and Type	Method and Description
AttributeSet	attributes()
boolean	autoConfig() Deprecated. Since 11.0, with no replacement.
boolean	enabled() Determines if indexing is enabled for this cache configuration.
ElementDefinition	getElementDefinition()
Index	index() Deprecated. Since 11. This configuration will be removed in next major version as the index mode is calculated automatically.
Set<Class<?>>	indexedEntities() Deprecated. since 11. Usages should be converted to indexedEntityTypes() as this method will be removed in next major version.
Set<String>	indexedEntityTypes() The set of fully qualified names of indexed entity types, either Java classes or protobuf type names.
boolean	indexShareable() Deprecated. Since 11.0 with no replacement; to be removed in next major version.
boolean	isVolatile() Does the index use a provider that does not persist upon restart?
Map<Class<?>,Class<?>>	keyTransformers() The currently configured key transformers.
TypedProperties	properties() These properties are passed directly to the embedded Hibernate Search engine, so for the complete and up to date documentation about available properties refer to the Hibernate Search reference of the version you're using with Infinispan Query.
String	toString()

Methods inherited from class org.infinispan.commons.configuration.AbstractTypedPropertiesConfiguration

attributeSet, equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commons.configuration.attributes.Matchable

matches

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationInfo

subElements

Field Detail

INDEX

@Deprecated
public static final AttributeDefinition<Index> INDEX

Deprecated. since 11.0

ENABLED

public static final AttributeDefinition<Boolean> ENABLED

AUTO_CONFIG

public static final AttributeDefinition<Boolean> AUTO_CONFIG

KEY_TRANSFORMERS

public static final AttributeDefinition<Map<Class<?>,Class<?>>> KEY_TRANSFORMERS

INDEXED_ENTITIES

public static final AttributeDefinition<Set<String>> INDEXED_ENTITIES

Method Detail

getElementDefinition

public ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

properties

public TypedProperties properties()

These properties are passed directly to the embedded Hibernate Search engine, so for the complete and up to date documentation about available properties refer to the Hibernate Search reference of the version you're using with Infinispan Query.

Overrides:

properties in class AbstractTypedPropertiesConfiguration

See Also:

Hibernate Search

index

@Deprecated
public Index index()

Deprecated. Since 11. This configuration will be removed in next major version as the index mode is calculated automatically.

Returns the indexing mode of this cache.

enabled

public boolean enabled()

Determines if indexing is enabled for this cache configuration.

autoConfig

@Deprecated
public boolean autoConfig()

Deprecated. Since 11.0, with no replacement.

Determines if autoconfig is enabled for this IndexingConfiguration.

keyTransformers

public Map<Class<?>,Class<?>> keyTransformers()

The currently configured key transformers.

Returns:

a Map in which the map key is the key class and the value is the Transformer class.

indexedEntities

@Deprecated
public Set<Class<?>> indexedEntities()

Deprecated. since 11. Usages should be converted to indexedEntityTypes() as this method will be removed in next major version.

The subset of indexed entity classes. This does not include the protobuf types. For the entire set of types use indexedEntityTypes().

indexedEntityTypes

public Set<String> indexedEntityTypes()

The set of fully qualified names of indexed entity types, either Java classes or protobuf type names. This configuration corresponds to the <indexed-entities> XML configuration element.

attributes

public AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

indexShareable

@Deprecated
public final boolean indexShareable()

Deprecated. Since 11.0 with no replacement; to be removed in next major version.

Check if the indexes can be shared. Currently no index can be shared, so it always returns false. sharing.

Returns:

always false, starting with version 11.0

isVolatile

public boolean isVolatile()

Does the index use a provider that does not persist upon restart?

toString

public String toString()

Overrides:

toString in class AbstractTypedPropertiesConfiguration