Interface ProjectingLuceneOperations

All Superinterfaces:
LuceneOperations
All Known Implementing Classes:
ProjectingLuceneAccessor, ProjectingLuceneAccessorSupport, ProjectingLuceneOperationsSupport, ProjectingLuceneTemplate

public interface ProjectingLuceneOperations extends LuceneOperations
The ProjectingLuceneOperations interface defines a contract for implementing classes to execute Lucene data access operations and mapping the results to entity domain types.
Since:
1.1.0
Author:
John Blum
See Also:
  • Method Details

    • query

      default <T> List<T> query(String query, String defaultField, Class<T> projectionType)
      Executes the given query with the results projected as instances of the projectionType.
      Type Parameters:
      T - Class type of the projection.
      Parameters:
      query - Lucene query to execute.
      defaultField - String specifying the default field used in Lucene queries when a field is not explicitly defined in the Lucene query clause.
      projectionType - Class type of the individual elements in the query results.
      Returns:
      a List of Lucene query results projected as instances of projectionType.
      See Also:
    • query

      <T> List<T> query(String query, String defaultField, int resultLimit, Class<T> projectionType)
      Executes the given query with the limited results projected as instances of the projectionType.
      Type Parameters:
      T - Class type of the projection.
      Parameters:
      query - Lucene query to execute.
      defaultField - String specifying the default field used in Lucene queries when a field is not explicitly defined in the Lucene query clause.
      resultLimit - limit on the number of query results to return.
      projectionType - Class type of the individual elements in the query results.
      Returns:
      a List of Lucene query results projected as instances of projectionType.
      See Also:
    • query

      <T> Page<T> query(String query, String defaultField, int resultLimit, int pageSize, Class<T> projectionType)
      Executes the given query with the limited results projected as instances of the projectionType.
      Type Parameters:
      T - Class type of the projection.
      Parameters:
      query - Lucene query to execute.
      defaultField - String specifying the default field used in Lucene queries when a field is not explicitly defined in the Lucene query clause.
      resultLimit - limit on the number of query results to return.
      pageSize - number of results on a Page.
      projectionType - Class type of the individual elements in the query results.
      Returns:
      the first Page of results returned from the Lucene query.
      See Also:
    • query

      default <T> List<T> query(LuceneQueryProvider queryProvider, Class<T> projectionType)
      Executes the provided query with the results projected as instances of the projectionType.
      Type Parameters:
      T - Class type of the projection.
      Parameters:
      queryProvider - LuceneQueryProvider providing the Lucene query to execute.
      projectionType - Class type of the individual elements in the query results.
      Returns:
      a List of Lucene query results projected as instances of projectionType.
      See Also:
    • query

      <T> List<T> query(LuceneQueryProvider queryProvider, int resultLimit, Class<T> projectionType)
      Executes the provided query with the limited results projected as instances of the projectionType.
      Type Parameters:
      T - Class type of the projection.
      Parameters:
      queryProvider - LuceneQueryProvider providing the Lucene query to execute.
      resultLimit - limit on the number of query results to return.
      projectionType - Class type of the individual elements in the query results.
      Returns:
      a List of Lucene query results projected as instances of projectionType.
      See Also:
    • query

      <T> Page<T> query(LuceneQueryProvider queryProvider, int resultLimit, int pageSize, Class<T> projectionType)
      Executes the provided query with the limited results projected as instances of the projectionType.
      Type Parameters:
      T - Class type of the projection.
      Parameters:
      queryProvider - LuceneQueryProvider providing the Lucene query to execute.
      resultLimit - limit on the number of query results to return.
      pageSize - number of results on a Page.
      projectionType - Class type of the individual elements in the query results.
      Returns:
      the first Page of results returned from the Lucene query.
      See Also: