Module org.jooq
Package org.jooq.impl

Interface QOM.XMLPi

All Superinterfaces:
Field<XML>, FieldOrConstraint, FieldOrRow, FieldOrRowOrSelect, GroupField, Named, OrderField<XML>, QueryPart, SelectField<XML>, SelectFieldOrAsterisk, Serializable, TableElement, Typed<XML>
Enclosing class:

public static interface QOM.XMLPi extends Field<XML>
The XMLPI function.
  • Method Details

    • $target

      @NotNull default @NotNull Name $target()
    • $target

      @CheckReturnValue @NotNull default @NotNull QOM.XMLPi $target(Name newTarget)
    • $content

      @Nullable default @Nullable Field<?> $content()
    • $content

      @CheckReturnValue @NotNull default @NotNull QOM.XMLPi $content(Field<?> newContent)
    • $arg1

      Name $arg1()
    • $arg2

      Field<?> $arg2()
    • $arg1

      @CheckReturnValue @NotNull default QOM.XMLPi $arg1(Name newArg1)
    • $arg2

      @CheckReturnValue @NotNull default QOM.XMLPi $arg2(Field<?> newArg2)
    • $constructor

      @NotNull @NotNull Function2<? super Name,? super Field<?>,? extends QOM.XMLPi> $constructor()
    • $args

      @NotNull default @NotNull List<?> $args()
    • $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).


      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.

      While replacing contents, this QueryPart isn't modified. Instead, a new object is returned.

      This is a commercial jOOQ edition only feature.

      Specified by:
      $replace in interface QueryPart