Package org.infinispan.query

Interface SearchManager

  • public interface SearchManager
    The SearchManager is the entry point to create full text queries on top of an indexed cache.
    Author:
    Sanne Grinovero <sanne@hibernate.org> (C) 2011 Red Hat Inc., Marko Luksa

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.apache.lucene.analysis.Analyzer getAnalyzer​(java.lang.Class<?> clazz)
      Retrieves the scoped analyzer for a given class type.
      org.apache.lucene.analysis.Analyzer getAnalyzer​(java.lang.String name)
      Retrieve an analyzer instance by its definition name
      MassIndexer getMassIndexer()
      The MassIndexer can be used to rebuild the Lucene indexes from the entries stored in Infinispan.
      <E> CacheQuery<E> getQuery​(java.lang.String queryString)
      Builds a CacheQuery from an Ickle query string, assuming the correct value for IndexedQueryMode to query all data in the cluster
      <E> CacheQuery<E> getQuery​(java.lang.String queryString, IndexedQueryMode indexedQueryMode)
      Builds a CacheQuery from an Ickle query string.
      org.hibernate.search.stat.Statistics getStatistics()
      Get access to the Query specific statistics for this SearchManager instance
      void purge​(java.lang.Class<?> entityType)
      Remove all entities of particular class from the index.
      <T> T unwrap​(java.lang.Class<T> cls)
      This method gives access to internal Infinispan implementation details, and should not be normally needed.

    • Method Detail

      • getQuery

        <E> CacheQuery<E> getQuery​(java.lang.String queryString,
                           IndexedQueryMode indexedQueryMode)
        Builds a CacheQuery from an Ickle query string.
        Throws:
        org.hibernate.search.exception.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.

      • getQuery

        <E> CacheQuery<E> getQuery​(java.lang.String queryString)
        Builds a CacheQuery from an Ickle query string, assuming the correct value for IndexedQueryMode to query all data in the cluster
        Parameters:
        queryString - the Ickle query
        Returns:

      • getMassIndexer

        MassIndexer getMassIndexer()
        The MassIndexer can be used to rebuild the Lucene indexes from the entries stored in Infinispan.
        Returns:
        the MassIndexer component

      • 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

        org.apache.lucene.analysis.Analyzer getAnalyzer​(java.lang.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

      • getAnalyzer

        org.apache.lucene.analysis.Analyzer getAnalyzer​(java.lang.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:
        java.lang.IllegalArgumentException - in case clazz == null or the specified class is not an indexed entity.
        Since:
        7.0

      • purge

        void purge​(java.lang.Class<?> entityType)
        Remove all entities of particular class from the index.
        Parameters:
        entityType - The class of the entity to remove.

      • unwrap

        <T> T unwrap​(java.lang.Class<T> cls)
        This method gives access to internal Infinispan implementation details, and should not be normally needed. The interface of the internal types does not constitute a public API and can (and probably will) change without notice.
        Parameters:
        cls - the class of the desired internal component
        Returns:
        the 'unwrapped' internal component
        Throws:
        java.lang.IllegalArgumentException - if the class of the requested internal component is not recognized