Package org.infinispan.query.spi

Interface SearchManagerImplementor

All Superinterfaces:

SearchManager

All Known Implementing Classes:

SearchManagerImpl

public interface SearchManagerImplementor
extends SearchManager

Method Summary

Modifier and Type	Method	Description
<E> CacheQuery<E>	getQuery(QueryDefinition queryDefinition, IndexedQueryMode indexedQueryMode, org.hibernate.search.spi.IndexedTypeMap<org.hibernate.search.spi.CustomTypeMetadata> indexedTypeMap)	Creates a cache query based on a QueryDefinition and a custom metadata.
void	registerKeyTransformer(Class<?> keyClass, Class<? extends Transformer> transformerClass)	Registers a Transformer for the supplied key class.
void	setTimeoutExceptionFactory(org.hibernate.search.query.engine.spi.TimeoutExceptionFactory timeoutExceptionFactory)	Define the timeout exception factory to customize the exception thrown when the query timeout is exceeded.

Methods inherited from interface org.infinispan.query.SearchManager

buildQueryBuilderForClass, getAnalyzer, getAnalyzer, getClusteredQuery, getMassIndexer, getQuery, getQuery, getQuery, getStatistics, purge, unwrap

Method Detail

registerKeyTransformer

void registerKeyTransformer(Class<?> keyClass,
                            Class<? extends Transformer> transformerClass)

Registers a Transformer for the supplied key class. When storing keys in cache that are neither simple (String, int, ...) nor annotated with @Transformable, Infinispan-Query will need to know what Transformer to use when transforming the keys to Strings. Clients must specify what Transformer to use for a particular key class by registering it through this method.

WARNING: this method registers the transformer on the local node only (see https://issues.jboss.org/browse/ISPN-9513)

Parameters:

keyClass - the key class for which the supplied transformerClass should be used

transformerClass - the transformer class to use for the supplied key class

setTimeoutExceptionFactory

void setTimeoutExceptionFactory(org.hibernate.search.query.engine.spi.TimeoutExceptionFactory timeoutExceptionFactory)

Define the timeout exception factory to customize the exception thrown when the query timeout is exceeded.

Parameters:

timeoutExceptionFactory - the timeout exception factory to use

getQuery

<E> CacheQuery<E> getQuery(QueryDefinition queryDefinition,
                           IndexedQueryMode indexedQueryMode,
                           org.hibernate.search.spi.IndexedTypeMap<org.hibernate.search.spi.CustomTypeMetadata> indexedTypeMap)

Creates a cache query based on a QueryDefinition and a custom metadata.