Package com.foreach.across.modules.entity.query

Interface EntityQueryFacade<T>

All Superinterfaces:
EntityQueryExecutor<T>
All Known Implementing Classes:
SimpleEntityQueryFacade
public interface EntityQueryFacade<T> extends EntityQueryExecutor<T>
Central component for working with EntityQuery and EQL statements for a particular entity type. Usually wraps around an EntityQueryParser that can translate EQL to EntityQuery, and an EntityQueryExecutor that can execute the actual query.
Since:
3.1.0
Author:
Arne Vandamme
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    EntityQuery
    convertToExecutableQuery(EntityQuery rawQuery)
    Convert a raw query to an executable query.
    default EntityQuery
    convertToExecutableQuery(String eql)
    Parses an EQL statement into an executable query, performing all necessary validation and type conversion.
    default List<T>
    findAll(String eql)
    Find all entities matching the eql statement.
    default org.springframework.data.domain.Page<T>
    findAll(String eql, org.springframework.data.domain.Pageable pageable)
    Find all entities matching the eql statement.
    default List<T>
    findAll(String eql, org.springframework.data.domain.Sort sort)
    Find all entities matching the eql statement and sort them using the sort parameter after applying the sort order present in the eql statement.

    Methods inherited from interface com.foreach.across.modules.entity.query.EntityQueryExecutor

    canExecute, findAll, findAll, findAll

  • Method Details

    • findAll

      default List<T> findAll(String eql)
      Find all entities matching the eql statement.
      Parameters:
      eql - query
      Returns:
      results

    • findAll

      default List<T> findAll(String eql, org.springframework.data.domain.Sort sort)
      Find all entities matching the eql statement and sort them using the sort parameter after applying the sort order present in the eql statement.
      Parameters:
      eql - query
      Returns:
      results

    • findAll

      default org.springframework.data.domain.Page<T> findAll(String eql, org.springframework.data.domain.Pageable pageable)
      Find all entities matching the eql statement. Apply the pageable to the result set (page selection + optional sorting).
      Parameters:
      eql - query
      Returns:
      results

    • convertToExecutableQuery

      default EntityQuery convertToExecutableQuery(String eql)
      Parses an EQL statement into an executable query, performing all necessary validation and type conversion.
      Parameters:
      eql - statement
      Returns:
      executable query instance

    • convertToExecutableQuery

      EntityQuery convertToExecutableQuery(EntityQuery rawQuery)
      Convert a raw query to an executable query. This usually verifies the selected properties and converts the condition arguments to the correct types.
      Parameters:
      rawQuery - to convert
      Returns:
      executable query instance