Interface CriteriaQuerySource<T>

Type Parameters:
T - The type of elements returned by iterator.
All Known Subinterfaces:
KeyValueView<K,V>, RecordView<R>

public interface CriteriaQuerySource<T>
Represents an entity that can be used to execute predicate-based criteria queries.
  • Method Details

    • query

      default Cursor<T> query(@Nullable @Nullable Transaction tx, @Nullable @Nullable Criteria criteria)
      Executes predicate-based criteria query.
      Parameters:
      tx - Transaction to execute the query within or null to run within implicit transaction.
      criteria - The predicate to filter entries or null to return all entries from the underlying table.
      Returns:
      Iterator with query results.
      Throws:
      CriteriaException - If failed.
    • query

      default Cursor<T> query(@Nullable @Nullable Transaction tx, @Nullable @Nullable Criteria criteria, @Nullable @Nullable String indexName)
      Executes predicate-based criteria query.
      Parameters:
      tx - Transaction to execute the query within or null to run within implicit transaction.
      criteria - The predicate to filter entries or null to return all entries from the underlying table.
      indexName - The name of the index to force usage in the query or null to use the default.
      Returns:
      Iterator with query results.
      Throws:
      CriteriaException - If failed.
    • query

      Cursor<T> query(@Nullable @Nullable Transaction tx, @Nullable @Nullable Criteria criteria, @Nullable @Nullable String indexName, @Nullable @Nullable CriteriaQueryOptions opts)
      Executes a predicate-based criteria query.
      Parameters:
      tx - Transaction to execute the query within or null to run within implicit transaction.
      criteria - The predicate to filter entries or null to return all entries from the underlying table.
      indexName - The name of the index to force usage in the query or null to use the default.
      opts - Criteria query options or null to use default.
      Returns:
      Iterator with query results.
      Throws:
      CriteriaException - If failed.
    • queryAsync

      default CompletableFuture<AsyncCursor<T>> queryAsync(@Nullable @Nullable Transaction tx, @Nullable @Nullable Criteria criteria)
      Executes a predicate-based criteria query in an asynchronous way.
      Parameters:
      tx - Transaction to execute the query within or null to run within implicit transaction.
      criteria - The predicate to filter entries or null to return all entries from the underlying table.
      Returns:
      Future that represents the pending completion of the operation.
      Throws:
      CriteriaException - If failed.
    • queryAsync

      default CompletableFuture<AsyncCursor<T>> queryAsync(@Nullable @Nullable Transaction tx, @Nullable @Nullable Criteria criteria, @Nullable @Nullable String indexName)
      Executes a predicate-based criteria query in an asynchronous way.
      Parameters:
      tx - Transaction to execute the query within or null to run within implicit transaction.
      criteria - The predicate to filter entries or null to return all entries from the underlying table.
      indexName - The name of the index to force usage in the query or null to use the default.
      Returns:
      Future that represents the pending completion of the operation.
      Throws:
      CriteriaException - If failed.
    • queryAsync

      CompletableFuture<AsyncCursor<T>> queryAsync(@Nullable @Nullable Transaction tx, @Nullable @Nullable Criteria criteria, @Nullable @Nullable String indexName, @Nullable @Nullable CriteriaQueryOptions opts)
      Executes a predicate-based criteria query in an asynchronous way.
      Parameters:
      tx - Transaction to execute the query within or null to run within implicit transaction.
      criteria - The predicate to filter entries or null to return all entries from the underlying table.
      indexName - The name of the index to force usage in the query or null to use the default.
      opts - Criteria query options or null to use default.
      Returns:
      Future that represents the pending completion of the operation.
      Throws:
      CriteriaException - If failed.