Package io.micronaut.data.model.jpa.criteria

Interface PersistentEntityCriteriaBuilder

All Superinterfaces:
jakarta.persistence.criteria.CriteriaBuilder
All Known Subinterfaces:
SourcePersistentEntityCriteriaBuilder
All Known Implementing Classes:
AbstractCriteriaBuilder, MethodMatchSourcePersistentEntityCriteriaBuilderImpl, RuntimeCriteriaBuilder, SourcePersistentEntityCriteriaBuilderImpl
public interface PersistentEntityCriteriaBuilder extends jakarta.persistence.criteria.CriteriaBuilder
The persistent entity criteria builder.
Since:
3.2
Author:
Denis Stepanov

  • Nested Class Summary

    Nested classes/interfaces inherited from interface jakarta.persistence.criteria.CriteriaBuilder

    jakarta.persistence.criteria.CriteriaBuilder.Case<R extends Object>, jakarta.persistence.criteria.CriteriaBuilder.Coalesce<T extends Object>, jakarta.persistence.criteria.CriteriaBuilder.In<T extends Object>, jakarta.persistence.criteria.CriteriaBuilder.SimpleCase<C extends Object,R extends Object>, jakarta.persistence.criteria.CriteriaBuilder.Trimspec

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.persistence.criteria.Predicate
    and(Iterable<jakarta.persistence.criteria.Predicate> restrictions)
    AND restriction predicate.
    jakarta.persistence.criteria.Predicate
    arrayContains(jakarta.persistence.criteria.Expression<?> x, jakarta.persistence.criteria.Expression<?> y)
    Checks if array contains given expression.
    jakarta.persistence.criteria.Predicate
    containsString(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
    Checks if the expression x contains the expression y.
    jakarta.persistence.criteria.Predicate
    containsStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
    Checks if the expression x contains the expression y ignoring case.
    <T> PersistentEntityCriteriaDelete<T>
    createCriteriaDelete(Class<T> targetEntity)
     
    <T> PersistentEntityCriteriaUpdate<T>
    createCriteriaUpdate(Class<T> targetEntity)
     
    PersistentEntityCriteriaQuery<Object>
    createQuery()
     
    <T> PersistentEntityCriteriaQuery<T>
    createQuery(Class<T> resultClass)
     
    PersistentEntityCriteriaQuery<jakarta.persistence.Tuple>
    createTupleQuery()
     
    jakarta.persistence.criteria.Predicate
    endingWithString(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
    Checks if the expression x ending with the expression y.
    jakarta.persistence.criteria.Predicate
    endingWithStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
    Checks if the expression x ending with the expression y ignoring case.
    jakarta.persistence.criteria.Predicate
    equalStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
    Checks if the expression x equals the expression y ignoring case.
    jakarta.persistence.criteria.Predicate
    equalStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, String y)
    Checks if the expression x equals a string y ignoring case.
    jakarta.persistence.criteria.Predicate
    ilike(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> pattern)
    Creates an case-insensitive like predicate.
    default jakarta.persistence.criteria.Predicate
    ilike(jakarta.persistence.criteria.Expression<String> x, String pattern)
    Creates an case-insensitive like predicate.
    jakarta.persistence.criteria.Predicate
    isEmptyString(jakarta.persistence.criteria.Expression<String> expression)
    Checks if the expression is empty.
    jakarta.persistence.criteria.Predicate
    isNotEmptyString(jakarta.persistence.criteria.Expression<String> expression)
    Checks if the expression is not empty.
    jakarta.persistence.criteria.Predicate
    notEqualStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
    Checks if the expression x not equals the expression y ignoring case.
    jakarta.persistence.criteria.Predicate
    notEqualStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, String y)
    Checks if the expression x not equals a string y ignoring case.
    jakarta.persistence.criteria.Predicate
    or(Iterable<jakarta.persistence.criteria.Predicate> restrictions)
    OR restriction predicate.
    jakarta.persistence.criteria.Predicate
    regex(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> pattern)
    Create a predicate for testing whether the expression satisfies the given pattern.
    @NonNull jakarta.persistence.criteria.Order
    sort(@NonNull jakarta.persistence.criteria.Expression<?> x, boolean ascending, boolean ignoreCase)
    Create an ordering.
    jakarta.persistence.criteria.Predicate
    startsWithString(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
    Checks if the expression x starts with the expression y.
    jakarta.persistence.criteria.Predicate
    startsWithStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
    Checks if the expression x starts with the expression y ignoring case.

    Methods inherited from interface jakarta.persistence.criteria.CriteriaBuilder

    abs, all, and, and, any, array, asc, avg, between, between, ceiling, coalesce, coalesce, coalesce, concat, concat, concat, conjunction, construct, count, countDistinct, currentDate, currentTime, currentTimestamp, desc, diff, diff, diff, disjunction, equal, equal, exists, exp, floor, function, ge, ge, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, greatest, gt, gt, in, isEmpty, isFalse, isMember, isMember, isNotEmpty, isNotMember, isNotMember, isNotNull, isNull, isTrue, keys, le, le, least, length, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo, like, like, like, like, like, like, literal, ln, localDate, localDateTime, localTime, locate, locate, locate, locate, lower, lt, lt, max, min, mod, mod, mod, neg, not, notEqual, notEqual, notLike, notLike, notLike, notLike, notLike, notLike, nullif, nullif, nullLiteral, or, or, parameter, parameter, power, power, prod, prod, prod, quot, quot, quot, round, selectCase, selectCase, sign, size, size, some, sqrt, substring, substring, substring, substring, sum, sum, sum, sum, sumAsDouble, sumAsLong, toBigDecimal, toBigInteger, toDouble, toFloat, toInteger, toLong, toString, treat, treat, treat, treat, treat, treat, treat, trim, trim, trim, trim, trim, trim, tuple, upper, values

  • Method Details

    • createQuery

      PersistentEntityCriteriaQuery<Object> createQuery()
      Specified by:
      createQuery in interface jakarta.persistence.criteria.CriteriaBuilder

    • createQuery

      <T> PersistentEntityCriteriaQuery<T> createQuery(Class<T> resultClass)
      Specified by:
      createQuery in interface jakarta.persistence.criteria.CriteriaBuilder

    • createTupleQuery

      PersistentEntityCriteriaQuery<jakarta.persistence.Tuple> createTupleQuery()
      Specified by:
      createTupleQuery in interface jakarta.persistence.criteria.CriteriaBuilder

    • createCriteriaUpdate

      <T> PersistentEntityCriteriaUpdate<T> createCriteriaUpdate(Class<T> targetEntity)
      Specified by:
      createCriteriaUpdate in interface jakarta.persistence.criteria.CriteriaBuilder

    • createCriteriaDelete

      <T> PersistentEntityCriteriaDelete<T> createCriteriaDelete(Class<T> targetEntity)
      Specified by:
      createCriteriaDelete in interface jakarta.persistence.criteria.CriteriaBuilder

    • sort

      @NonNull @NonNull jakarta.persistence.criteria.Order sort(@NonNull @NonNull jakarta.persistence.criteria.Expression<?> x, boolean ascending, boolean ignoreCase)
      Create an ordering.
      Parameters:
      x - expression used to define the ordering
      ascending - If ascending should be use
      ignoreCase - If ignore case should be used
      Returns:
      ascending ordering corresponding to the expression

    • or

      jakarta.persistence.criteria.Predicate or(Iterable<jakarta.persistence.criteria.Predicate> restrictions)
      OR restriction predicate.
      Parameters:
      restrictions - The restriction
      Returns:
      a new predicate

    • and

      jakarta.persistence.criteria.Predicate and(Iterable<jakarta.persistence.criteria.Predicate> restrictions)
      AND restriction predicate.
      Parameters:
      restrictions - The restriction
      Returns:
      a new predicate

    • isEmptyString

      jakarta.persistence.criteria.Predicate isEmptyString(jakarta.persistence.criteria.Expression<String> expression)
      Checks if the expression is empty.
      Parameters:
      expression - The expression
      Returns:
      a new predicate

    • isNotEmptyString

      jakarta.persistence.criteria.Predicate isNotEmptyString(jakarta.persistence.criteria.Expression<String> expression)
      Checks if the expression is not empty.
      Parameters:
      expression - The expression
      Returns:
      a new predicate

    • ilike

      jakarta.persistence.criteria.Predicate ilike(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> pattern)
      Creates an case-insensitive like predicate.
      Parameters:
      x - The expression
      pattern - The pattern
      Returns:
      a new predicate

    • ilike

      default jakarta.persistence.criteria.Predicate ilike(jakarta.persistence.criteria.Expression<String> x, String pattern)
      Creates an case-insensitive like predicate.
      Parameters:
      x - The expression
      pattern - The pattern
      Returns:
      a new predicate

    • startsWithString

      jakarta.persistence.criteria.Predicate startsWithString(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
      Checks if the expression x starts with the expression y.
      Parameters:
      x - The expression
      y - The expression
      Returns:
      a new predicate

    • endingWithString

      jakarta.persistence.criteria.Predicate endingWithString(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
      Checks if the expression x ending with the expression y.
      Parameters:
      x - The expression
      y - The expression
      Returns:
      a new predicate

    • containsString

      jakarta.persistence.criteria.Predicate containsString(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
      Checks if the expression x contains the expression y.
      Parameters:
      x - The expression
      y - The expression
      Returns:
      a new predicate

    • containsStringIgnoreCase

      jakarta.persistence.criteria.Predicate containsStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
      Checks if the expression x contains the expression y ignoring case.
      Parameters:
      x - The expression
      y - The expression
      Returns:
      a new predicate

    • equalStringIgnoreCase

      jakarta.persistence.criteria.Predicate equalStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, String y)
      Checks if the expression x equals a string y ignoring case.
      Parameters:
      x - The expression
      y - The string
      Returns:
      a new predicate

    • equalStringIgnoreCase

      jakarta.persistence.criteria.Predicate equalStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
      Checks if the expression x equals the expression y ignoring case.
      Parameters:
      x - The expression
      y - The string
      Returns:
      a new predicate

    • notEqualStringIgnoreCase

      jakarta.persistence.criteria.Predicate notEqualStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, String y)
      Checks if the expression x not equals a string y ignoring case.
      Parameters:
      x - The expression
      y - The string
      Returns:
      a new predicate

    • notEqualStringIgnoreCase

      jakarta.persistence.criteria.Predicate notEqualStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
      Checks if the expression x not equals the expression y ignoring case.
      Parameters:
      x - The expression
      y - The string
      Returns:
      a new predicate

    • startsWithStringIgnoreCase

      jakarta.persistence.criteria.Predicate startsWithStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
      Checks if the expression x starts with the expression y ignoring case.
      Parameters:
      x - The expression
      y - The string
      Returns:
      a new predicate

    • endingWithStringIgnoreCase

      jakarta.persistence.criteria.Predicate endingWithStringIgnoreCase(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> y)
      Checks if the expression x ending with the expression y ignoring case.
      Parameters:
      x - The expression
      y - The string
      Returns:
      a new predicate

    • regex

      jakarta.persistence.criteria.Predicate regex(jakarta.persistence.criteria.Expression<String> x, jakarta.persistence.criteria.Expression<String> pattern)
      Create a predicate for testing whether the expression satisfies the given pattern.
      Parameters:
      x - string expression
      pattern - string expression
      Returns:
      like predicate

    • arrayContains

      jakarta.persistence.criteria.Predicate arrayContains(jakarta.persistence.criteria.Expression<?> x, jakarta.persistence.criteria.Expression<?> y)
      Checks if array contains given expression. Supported by Azure Cosmos Db and MongoDB.
      Parameters:
      x - The expression (property)
      y - The expression (value to be contained in the array represented by x property in the db)
      Returns:
      a new predicate
      Since:
      3.9.0