Module org.jooq
Package org.jooq.impl

Interface QOM.Contains<T>

All Superinterfaces:
Condition, QOM.CompareCondition<T>, QueryPart, Serializable
Enclosing class:
QOM

public static interface QOM.Contains<T> extends QOM.CompareCondition<T>
The CONTAINS operator.

Convenience method for #like(String, char) including proper adding of wildcards and escaping.

SQL: this like ('%' || escape(value, '\') || '%') escape '\'

Note: This also works with numbers, for instance val(1133).contains(13)

If you're using SQLDialect.POSTGRES, then you can use this method also to express the "ARRAY contains" operator. For example:


 // Use this expression
 val(new Integer[] { 1, 2, 3 }).contains(new Integer[] { 1, 2 })

 // ... to render this SQL
 ARRAY[1, 2, 3] @> ARRAY[1, 2]
 

Note, this does not correspond to the Oracle Text CONTAINS() function. Refer to OracleDSL.contains(Field, String) instead.

  • Method Details

    • $value

      @NotNull default @NotNull Field<T> $value()
    • $content

      @NotNull default @NotNull Field<T> $content()
    • $arg1

      Field<T> $arg1()
    • $arg2

      Field<T> $arg2()
    • $arg1

      @NotNull default Condition $arg1(Field<T> newArg1)
    • $arg2

      @NotNull default Condition $arg2(Field<T> newArg2)
    • constructor

      @NotNull @NotNull Function2<? super Field<T>,? super Field<T>,? extends Condition> constructor()
    • $traverse

      default <T> T $traverse(Traverser<?,T> traverser)
      Description copied from interface: QueryPart
      Traverser this QueryPart expression tree using a composable Traverser, producing a result.

      This offers a generic way to traverse expression trees to translate the tree to arbitrary other data structures. The simplest traversal would just count all the tree elements:

      
       int count = CUSTOMER.NAME.eq(1).$traverse(0, (i, p) -> i + 1);
       

      The same can be achieved by translating the JDK Collector API to the Traverser API using Traversers.collecting(Collector).

      
       CUSTOMER.NAME.eq(1).$traverse(Traversers.collecting(Collectors.counting()));
       

      Unlike a Collector, a Traverser is optimised for tree traversal, not stream traversal:

      • Is not designed for parallelism
      • It can Traverser.abort() traversal early when the result can be produced early (e.g. when running Traversers.containing(QueryPart), and a result has been found).
      • It can decide whether to Traverser.recurse() into a QueryPart subtree, or whether that is not necessary or even undesirable, e.g. to prevent entering new subquery scopes.
      • Unlike a Collector, which can use its Collector.accumulator() to accumulate each element only once, in tree traversal, it's desirable to be able to distinguish between accumulating an item Traverser.before() or Traverser.after() recursing into it. This is useful e.g. to wrap each tree node in XML opening and closing tags.

      This is a commercial jOOQ edition only feature.

      Specified by:
      $traverse in interface QueryPart
    • $replace

      @NotNull default QueryPart $replace(Replacer replacer)
      Description copied from interface: QueryPart
      Traverse a QueryPart hierarchy and recursively replace its elements by alternatives.

      This is a commercial jOOQ edition only feature.

      Specified by:
      $replace in interface QueryPart