## Uses of Interface
org.hibernate.search.query.engine.spi.HSQuery

- Packages that use HSQuery
  Package | Description
  --- | ---
  org.hibernate.search.elasticsearch.impl |
  org.hibernate.search.elasticsearch.query.impl |
  org.hibernate.search.engine.impl |
  org.hibernate.search.query.engine.impl |
  org.hibernate.search.query.engine.spi |
  org.hibernate.search.query.hibernate.impl |
  org.hibernate.search.spi |

- - ### Uses of HSQuery in org.hibernate.search.elasticsearch.impl

    Methods in org.hibernate.search.elasticsearch.impl that return HSQuery
    Modifier and Type | Method and Description
    --- | ---
    `HSQuery` | ElasticsearchJsonQueryDescriptor.`createHSQuery(SearchIntegrator integrator, IndexedTypeMap<CustomTypeMetadata> types)`
    `HSQuery` | ElasticsearchJsonQueryDescriptor.`createHSQuery(SearchIntegrator integrator, IndexedTypeSet types)`

  - ### Uses of HSQuery in org.hibernate.search.elasticsearch.query.impl

    Classes in org.hibernate.search.elasticsearch.query.impl that implement HSQuery
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ElasticsearchHSQueryImpl` Query implementation based on Elasticsearch.

    Methods in org.hibernate.search.elasticsearch.query.impl that return HSQuery
    Modifier and Type | Method and Description
    --- | ---
    `HSQuery` | ElasticsearchHSQueryImpl.`luceneQuery(Query query)`

  - ### Uses of HSQuery in org.hibernate.search.engine.impl

    Methods in org.hibernate.search.engine.impl that return HSQuery
    Modifier and Type | Method and Description
    --- | ---
    `HSQuery` | ImmutableSearchFactory.`createHSQuery(Query luceneQuery, Class<?>... entityTypes)`
    `HSQuery` | MutableSearchFactory.`createHSQuery(Query luceneQuery, Class<?>... entities)`
    `HSQuery` | ImmutableSearchFactory.`createHSQuery(Query luceneQuery, IndexedTypeMap<CustomTypeMetadata> types)`
    `HSQuery` | MutableSearchFactory.`createHSQuery(Query luceneQuery, IndexedTypeMap<CustomTypeMetadata> types)`
    `HSQuery` | LuceneQueryDescriptor.`createHSQuery(SearchIntegrator integrator, IndexedTypeMap<CustomTypeMetadata> types)`
    `HSQuery` | LuceneQueryDescriptor.`createHSQuery(SearchIntegrator integrator, IndexedTypeSet types)`

  - ### Uses of HSQuery in org.hibernate.search.query.engine.impl

    Classes in org.hibernate.search.query.engine.impl that implement HSQuery
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractHSQuery` Base class for `HSQuery` implementations, exposing basic state needed by all implementations.
    `class` | `LuceneHSQuery`

    Methods in org.hibernate.search.query.engine.impl that return HSQuery
    Modifier and Type | Method and Description
    --- | ---
    `HSQuery` | AbstractHSQuery.`filter(Filter filter)` Deprecated.
    `HSQuery` | AbstractHSQuery.`firstResult(int firstResult)`
    `HSQuery` | LuceneHSQuery.`luceneQuery(Query query)`
    `HSQuery` | AbstractHSQuery.`maxResults(int maxResults)`
    `HSQuery` | AbstractHSQuery.`projection(String... fields)`
    `HSQuery` | AbstractHSQuery.`setSpatialParameters(Coordinates center, String fieldName)`
    `HSQuery` | AbstractHSQuery.`sort(Sort sort)`
    `HSQuery` | AbstractHSQuery.`tenantIdentifier(String tenantId)`
    `HSQuery` | AbstractHSQuery.`timeoutExceptionFactory(TimeoutExceptionFactory exceptionFactory)`

  - ### Uses of HSQuery in org.hibernate.search.query.engine.spi

    Methods in org.hibernate.search.query.engine.spi that return HSQuery
    Modifier and Type | Method and Description
    --- | ---
    `HSQuery` | QueryDescriptor.`createHSQuery(SearchIntegrator integrator, IndexedTypeMap<CustomTypeMetadata> types)`
    `HSQuery` | QueryDescriptor.`createHSQuery(SearchIntegrator integrator, IndexedTypeSet types)`
    `HSQuery` | HSQuery.`filter(Filter filter)` Deprecated. use the `FullTextFilterDef` approach, or handle filtering when building the query (see `BooleanJunction.must(Query)` and `MustJunction.disableScoring()`).
    `HSQuery` | HSQuery.`firstResult(int firstResult)` Set the first element to retrieve.
    `HSQuery` | HSQuery.`luceneQuery(Query query)` Defines the underlying Lucene query
    `HSQuery` | HSQuery.`maxResults(int maxResults)` Set the maximum number of elements to retrieve.
    `HSQuery` | HSQuery.`projection(String... fields)` Defines the Lucene field names projected and returned in a query result Each field is converted back to it's object representation, an Object[] being returned for each "row" (similar to an HQL or a Criteria API projection).
    `HSQuery` | HSQuery.`setSpatialParameters(Coordinates center, String fieldName)` setSpatialParameters.
    `HSQuery` | HSQuery.`sort(Sort sort)` Lets Lucene sort the results.
    `HSQuery` | HSQuery.`tenantIdentifier(String tenantId)`
    `HSQuery` | HSQuery.`timeoutExceptionFactory(TimeoutExceptionFactory exceptionFactory)` Define the timeout exception factory to customize the exception returned by the user.

  - ### Uses of HSQuery in org.hibernate.search.query.hibernate.impl

    Constructors in org.hibernate.search.query.hibernate.impl with parameters of type HSQuery
    Constructor and Description
    `FullTextQueryImpl(HSQuery hSearchQuery, SessionImplementor session, ParameterMetadata parameterMetadata)` Constructs a `FullTextQueryImpl` instance.

  - ### Uses of HSQuery in org.hibernate.search.spi

    Methods in org.hibernate.search.spi that return HSQuery
    Modifier and Type | Method and Description
    --- | ---
    `HSQuery` | SearchIntegrator.`createHSQuery(Query fullTextQuery, Class<?>... entityTypes)` Return an Hibernate Search query object.
    `HSQuery` | SearchIntegrator.`createHSQuery(Query fullTextQuery, IndexedTypeMap<CustomTypeMetadata> types)` Return an Hibernate Search query object.

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