org.infinispan.query.impl

Class SearchManagerImpl

java.lang.Object

org.infinispan.query.impl.SearchManagerImpl

All Implemented Interfaces:

SearchManager, SearchManagerImplementor

public class SearchManagerImpl
extends Object
implements SearchManagerImplementor

Class that is used to build CacheQuery

Since:

4.0

Author:

Navin Surtani, Sanne Grinovero (C) 2011 Red Hat Inc., Marko Luksa

Constructor Summary

Constructors

Constructor and Description
SearchManagerImpl(AdvancedCache<?,?> cache)

Method Summary

Methods

Modifier and Type	Method and Description
org.hibernate.search.query.dsl.EntityContext	buildQueryBuilderForClass(Class<?> entityType) Experimental.
CacheQuery	getClusteredQuery(org.apache.lucene.search.Query luceneQuery, Class<?>... classes) This probably should be hided in the getQuery method.
MassIndexer	getMassIndexer() The MassIndexer can be used to rebuild the Lucene indexes from the entries stored in Infinispan.
CacheQuery	getQuery(org.apache.lucene.search.Query luceneQuery, Class<?>... classes) This is a simple method that will just return a CacheQuery, filtered according to a set of classes passed in.
QueryFactory	getQueryFactory() Experimental! Obtains the factory for DSL-based queries.
org.hibernate.search.SearchFactory	getSearchFactory() Experimental.
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 class java.lang.Object

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

Constructor Detail

SearchManagerImpl

public SearchManagerImpl(AdvancedCache<?,?> cache)

Method Detail

getQueryFactory

public QueryFactory getQueryFactory()

Description copied from interface: SearchManager

Experimental! Obtains the factory for DSL-based queries.

Specified by:

getQueryFactory in interface SearchManager

Returns:

a factory capable of building queries for the cache this SearchManager belongs to

getQuery

public CacheQuery getQuery(org.apache.lucene.search.Query luceneQuery,
                  Class<?>... classes)

Description copied from interface: SearchManager

This is a simple method that will just return a CacheQuery, filtered according to a set of classes passed in. If no classes are passed in, it is assumed that no type filtering is performed and so all known types will be searched.

Specified by:

getQuery in interface SearchManager

Parameters:

luceneQuery - - Query

classes - - optionally only return results of type that matches this list of acceptable types

Returns:

the CacheQuery object which can be used to iterate through results

getClusteredQuery

public CacheQuery getClusteredQuery(org.apache.lucene.search.Query luceneQuery,
                           Class<?>... classes)

This probably should be hided in the getQuery method.

Specified by:

getClusteredQuery in interface SearchManager

Parameters:

luceneQuery -

classes -

Returns:

registerKeyTransformer

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

Description copied from interface: SearchManagerImplementor

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.

Specified by:

registerKeyTransformer in interface SearchManagerImplementor

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

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

Description copied from interface: SearchManagerImplementor

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

Specified by:

setTimeoutExceptionFactory in interface SearchManagerImplementor

Parameters:

timeoutExceptionFactory - the timeout exception factory to use

buildQueryBuilderForClass

public org.hibernate.search.query.dsl.EntityContext buildQueryBuilderForClass(Class<?> entityType)

Description copied from interface: SearchManager

Experimental. Provides Hibernate Search DSL to build full text queries

Specified by:

buildQueryBuilderForClass in interface SearchManager

Returns:

getSearchFactory

public org.hibernate.search.SearchFactory getSearchFactory()

Description copied from interface: SearchManager

Experimental. Access the SearchFactory

Specified by:

getSearchFactory in interface SearchManager

getMassIndexer

public MassIndexer getMassIndexer()

Description copied from interface: SearchManager

The MassIndexer can be used to rebuild the Lucene indexes from the entries stored in Infinispan.

Specified by:

getMassIndexer in interface SearchManager

Returns:

the MassIndexer component