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
EntityContext	buildQueryBuilderForClass(Class<?> entityType) Provides Hibernate Search DSL to build full text queries
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
<E> CacheQuery<E>	getClusteredQuery(Query luceneQuery, Class<?>... classes) Deprecated. since 9.2, use getQuery(Query, IndexedQueryMode, Class[]) with QueryMode.BROADCAST
MassIndexer	getMassIndexer() The MassIndexer can be used to rebuild the Lucene indexes from the entries stored in Infinispan.
<E> CacheQuery<E>	getQuery(Query luceneQuery, Class<?>... classes)
<E> CacheQuery<E>	getQuery(Query luceneQuery, IndexedQueryMode indexedQueryMode, Class<?>... classes) This is a simple method that will just return a CacheQuery, filtered according to a set of classes passed in.
<E> CacheQuery<E>	getQuery(String queryString, IndexedQueryMode indexedQueryMode, Class<?>... classes) Builds a CacheQuery from a query string.
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

<E> CacheQuery<E> getQuery(Query luceneQuery,
                           IndexedQueryMode indexedQueryMode,
                           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

indexedQueryMode - The IndexedQueryMode used when executing the 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.

getQuery

<E> CacheQuery<E> getQuery(String queryString,
                           IndexedQueryMode indexedQueryMode,
                           Class<?>... classes)

Builds a CacheQuery from a query string.

Throws:

SearchException - if the queryString cannot be converted to an indexed query, due to lack of indexes to resolve it fully or if contains aggregations and grouping.

See Also:

getQuery(Query, IndexedQueryMode, Class[])

getQuery

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

See Also:

getQuery(Query, IndexedQueryMode, Class[])

buildQueryBuilderForClass

EntityContext buildQueryBuilderForClass(Class<?> entityType)

Provides Hibernate Search DSL to build full text queries

Returns:

getClusteredQuery

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

Deprecated. since 9.2, use getQuery(Query, IndexedQueryMode, Class[]) with QueryMode.BROADCAST

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:

SearchException - if the definition name is unknown

Since:

7.0

getStatistics

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.