org.hibernate.search.query.engine.spi

## Interface QueryDescriptor

- All Known Implementing Classes:
    ElasticsearchJsonQueryDescriptor, LuceneQueryDescriptor

      public interface QueryDescriptor

  An index query which is able to create a corresponding `HSQuery` object.

  Note:In the hibernate-search-orm module, you may pass query descriptors to `org.hibernate.search.FullTextSession.createFullTextQuery(QueryDescriptor, Class<?>...)` to create a FullTextQuery.

  Author:
    Gunnar Morling

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `HSQuery` | `createHSQuery(SearchIntegrator integrator, IndexedTypeMap<CustomTypeMetadata> types)`
    `HSQuery` | `createHSQuery(SearchIntegrator integrator, IndexedTypeSet types)`

- - ### Method Detail

    - #### createHSQuery

          HSQuery createHSQuery(SearchIntegrator integrator,
                                IndexedTypeSet types)

      Parameters:
        `integrator` - the `SearchIntegrator` used to execute the query
        `types` - the list of classes (indexes) targeted by the query
      Returns:
        the resulting query

    - #### createHSQuery

          HSQuery createHSQuery(SearchIntegrator integrator,
                                IndexedTypeMap<CustomTypeMetadata> types)

      Parameters:
        `integrator` - the `SearchIntegrator` used to execute the query
        `types` - the targeted types, mapped to (potentially null) custom metadata which should override the supporting entity type's metadata
      Returns:
        the resulting query

Copyright © 2006-2017 Red Hat, Inc. All Rights Reserved