Package 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	Description
static AttributeDefinition<java.lang.Boolean>	AUTO_CONFIG
static AttributeDefinition<Index>	INDEX
static AttributeDefinition<java.util.Set<java.lang.Class<?>>>	INDEXED_ENTITIES
static AttributeDefinition<java.util.Map<java.lang.Class<?>,java.lang.Class<?>>>	KEY_TRANSFORMERS

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

attributes, PROPERTIES

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
boolean	autoConfig()	Determines if autoconfig is enabled for this IndexingConfiguration.
boolean	enabled()	Deprecated. Use index() instead
ElementDefinition	getElementDefinition()
Index	index()	Returns the indexing mode of this cache.
java.util.Set<java.lang.Class<?>>	indexedEntities()
boolean	indexLocalOnly()	Deprecated. Use index() instead
boolean	indexShareable()	Check if the indexes can be shared.
java.util.Map<java.lang.Class<?>,java.lang.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.
java.lang.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.ConfigurationInfo

subElements

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

matches

Field Detail

INDEX

public static final AttributeDefinition<Index> INDEX

AUTO_CONFIG

public static final AttributeDefinition<java.lang.Boolean> AUTO_CONFIG

KEY_TRANSFORMERS

public static final AttributeDefinition<java.util.Map<java.lang.Class<?>,java.lang.Class<?>>> KEY_TRANSFORMERS

INDEXED_ENTITIES

public static final AttributeDefinition<java.util.Set<java.lang.Class<?>>> INDEXED_ENTITIES

Method Detail

enabled

@Deprecated
public boolean enabled()

Deprecated.

Use index() instead

Whether indexing is enabled. False by default.

indexLocalOnly

@Deprecated
public boolean indexLocalOnly()

Deprecated.

Use index() instead

If true, only index changes made locally, ignoring remote changes. This is useful if indexes are shared across a cluster to prevent redundant indexing of updates.

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

public Index index()

Returns the indexing mode of this cache.

autoConfig

public boolean autoConfig()

Determines if autoconfig is enabled for this IndexingConfiguration.

keyTransformers

public java.util.Map<java.lang.Class<?>,java.lang.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

public java.util.Set<java.lang.Class<?>> indexedEntities()

attributes

public AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

indexShareable

public boolean indexShareable()

Check if the indexes can be shared. Currently only "ram" based indexes don't allow any sort of sharing.

Returns:

false if the index is ram only and thus not shared

toString

public java.lang.String toString()

Overrides:

toString in class AbstractTypedPropertiesConfiguration