org.infinispan.query

Interface SearchManager

public interface SearchManager

The SearchManager is the entry point to create full text queries on top of a cache.

Author:

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

Method Summary

Modifier and Type	Method and Description
org.hibernate.search.query.dsl.EntityContext	buildQueryBuilderForClass(Class<?> entityType) Experimental.
Analyzer	getAnalyzer(Class<?> clazz) Retrieves the scoped analyzer for a given class type.
Analyzer	getAnalyzer(String name) Retrieve an analyzer instance by its definition name
CacheQuery	getClusteredQuery(Query luceneQuery, Class<?>... classes) Experimental! Use it to try out the newly introduced distributed queries.
MassIndexer	getMassIndexer() The MassIndexer can be used to rebuild the Lucene indexes from the entries stored in Infinispan.
CacheQuery	getQuery(Query luceneQuery, Class<?>... classes) This is a simple method that will just return a CacheQuery, filtered according to a set of classes passed in.
org.hibernate.search.stat.Statistics	getStatistics() Get access to the Query specific statistics for this SearchManager instance
void	purge(Class<?> entityType) Remove all entities of particular class from the index.
<T> T	unwrap(Class<T> cls) This method gives access to internal Infinispan types, and should not be normally needed.

Method Detail

getQuery

CacheQuery getQuery(Query luceneQuery,
                    Class<?>... classes)

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.

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

buildQueryBuilderForClass

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

Experimental. Provides Hibernate Search DSL to build full text queries

Returns:

getClusteredQuery

CacheQuery getClusteredQuery(Query luceneQuery,
                             Class<?>... classes)

Experimental! Use it to try out the newly introduced distributed queries.

Parameters:

luceneQuery -

classes -

Returns:

getMassIndexer

MassIndexer getMassIndexer()

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

Returns:

the MassIndexer component

getAnalyzer

Analyzer getAnalyzer(String name)

Retrieve an analyzer instance by its definition name

Parameters:

name - the name of the analyzer

Returns:

analyzer with the specified name

Throws:

org.hibernate.search.exception.SearchException - if the definition name is unknown

Since:

7.0

getStatistics

org.hibernate.search.stat.Statistics getStatistics()

Get access to the Query specific statistics for this SearchManager instance

Returns:

The statistics.

Since:

7.0

getAnalyzer

Analyzer getAnalyzer(Class<?> clazz)

Retrieves the scoped analyzer for a given class type.

Parameters:

clazz - The class for which to retrieve the analyzer.

Returns:

The scoped analyzer for the specified class.

Throws:

IllegalArgumentException - in case clazz == null or the specified class is not an indexed entity.

Since:

7.0

purge

void purge(Class<?> entityType)

Remove all entities of particular class from the index.

Parameters:

entityType - The class of the entity to remove.

unwrap

<T> T unwrap(Class<T> cls)

This method gives access to internal Infinispan types, and should not be normally needed. The API of the internal types can (and probably will) change without notice.