Module org.jooq

Package org.jooq.impl

Interface QOM.Overlay

All Superinterfaces:

Field<String>, FieldOrConstraint, FieldOrRow, FieldOrRowOrSelect, GroupField, Named, OrderField<String>, QueryPart, SelectField<String>, SelectFieldOrAsterisk, Serializable, TableElement, Typed<String>

Enclosing class:

QOM

public static interface QOM.Overlay
extends Field<String>

The OVERLAY function.

Place a string on top of another string, replacing the original contents.

Method Summary

Modifier and Type	Method	Description
Field<String>	$arg1()
default QOM.Overlay	$arg1(Field<String> newArg1)
Field<String>	$arg2()
default QOM.Overlay	$arg2(Field<String> newArg2)
Field<? extends Number>	$arg3()
default QOM.Overlay	$arg3(Field<? extends Number> newArg3)
Field<? extends Number>	$arg4()
default QOM.Overlay	$arg4(Field<? extends Number> newArg4)
default @NotNull List<?>	$args()
@NotNull Function4<? super Field<String>,? super Field<String>,? super Field<? extends Number>,? super Field<? extends Number>,? extends QOM.Overlay>	$constructor()
default @NotNull Field<String>	$in()	The original string on top of which the overlay is placed.
default @NotNull QOM.Overlay	$in(Field<String> newIn)	The original string on top of which the overlay is placed.
default @Nullable Field<? extends Number>	$length()	The length in the original string that will be replaced, if different from the overlay length.
default @NotNull QOM.Overlay	$length(Field<? extends Number> newLength)	The length in the original string that will be replaced, if different from the overlay length.
default @NotNull Field<String>	$placing()	The string that is being placed on top of the other string.
default @NotNull QOM.Overlay	$placing(Field<String> newPlacing)	The string that is being placed on top of the other string.
default QueryPart	$replace(Replacer replacer)	Traverse a QueryPart hierarchy and recursively replace its elements by alternatives.
default @NotNull Field<? extends Number>	$startIndex()	The start index (1-based) starting from where the overlay is placed.
default @NotNull QOM.Overlay	$startIndex(Field<? extends Number> newStartIndex)	The start index (1-based) starting from where the overlay is placed.
default <T> T	$traverse(Traverser<?,T> traverser)	Traverser this QueryPart expression tree using a composable Traverser, producing a result.

Methods inherited from interface org.jooq.Field

abs, acos, add, add, as, as, as, as, asc, ascii, asin, atan, atan2, atan2, avg, avgOver, between, between, between, between, betweenSymmetric, betweenSymmetric, betweenSymmetric, betweenSymmetric, binaryLike, binaryLike, binaryLike, bitAnd, bitAnd, bitLength, bitNand, bitNand, bitNor, bitNor, bitNot, bitOr, bitOr, bitXNor, bitXNor, bitXor, bitXor, cast, cast, cast, ceil, changed, charLength, coalesce, coalesce, coerce, coerce, coerce, collate, collate, collate, comment, comment, compare, compare, compare, compare, concat, concat, concat, contains, contains, containsIgnoreCase, containsIgnoreCase, convert, convert, convert, convertFrom, convertFrom, convertTo, convertTo, cos, cosh, cot, coth, count, countDistinct, countOver, decode, decode, decode, decode, deg, desc, div, div, divide, divide, endsWith, endsWith, endsWithIgnoreCase, endsWithIgnoreCase, eq, eq, eq, eq, equal, equal, equal, equal, equalIgnoreCase, equalIgnoreCase, equals, exp, extract, field, firstValue, floor, from, ge, ge, ge, ge, get, getComment, getName, getValue, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterThan, greaterThan, greaterThan, greaterThan, greatest, greatest, gt, gt, gt, gt, in, in, in, in, in, isDistinctFrom, isDistinctFrom, isDistinctFrom, isDocument, isFalse, isJson, isNotDistinctFrom, isNotDistinctFrom, isNotDistinctFrom, isNotDocument, isNotJson, isNotNull, isNull, isTrue, lag, lag, lag, lag, lastValue, le, le, le, le, lead, lead, lead, lead, least, least, length, lessOrEqual, lessOrEqual, lessOrEqual, lessOrEqual, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeRegex, likeRegex, ln, log, lower, lpad, lpad, lpad, lpad, lt, lt, lt, lt, ltrim, max, maxOver, median, min, minOver, minus, minus, mod, mod, modulo, modulo, mul, mul, multiply, multiply, ne, ne, ne, ne, neg, notBetween, notBetween, notBetween, notBetween, notBetweenSymmetric, notBetweenSymmetric, notBetweenSymmetric, notBetweenSymmetric, notBinaryLike, notBinaryLike, notBinaryLike, notContains, notContains, notContainsIgnoreCase, notContainsIgnoreCase, notEqual, notEqual, notEqual, notEqual, notEqualIgnoreCase, notEqualIgnoreCase, notIn, notIn, notIn, notIn, notIn, notLike, notLike, notLike, notLike, notLike, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeRegex, notLikeRegex, notSimilarTo, notSimilarTo, notSimilarTo, notSimilarTo, notSimilarTo, nullif, nullif, nullsFirst, nullsLast, nvl, nvl, nvl2, nvl2, octetLength, original, plus, plus, plus, position, position, pow, pow, power, power, rad, rem, rem, repeat, repeat, replace, replace, replace, replace, reset, round, round, rpad, rpad, rpad, rpad, rtrim, shl, shl, shr, shr, sign, similarTo, similarTo, similarTo, similarTo, similarTo, sin, sinh, sort, sort, sortAsc, sortAsc, sortDefault, sortDesc, sortDesc, sqrt, startsWith, startsWith, startsWithIgnoreCase, startsWithIgnoreCase, stddevPop, stddevPopOver, stddevSamp, stddevSampOver, sub, sub, substring, substring, substring, substring, subtract, subtract, sum, sumOver, tan, tanh, times, times, touched, trim, unaryMinus, unaryPlus, upper, varPop, varPopOver, varSamp, varSampOver

Methods inherited from interface org.jooq.Named

$name, getCommentPart, getQualifiedName, getUnqualifiedName

Methods inherited from interface org.jooq.QueryPart

$replace, $traverse, hashCode, toString

Methods inherited from interface org.jooq.Typed

$dataType, getBinding, getConverter, getDataType, getDataType, getType

Method Details

$in

@NotNull
default @NotNull Field<String> $in()

The original string on top of which the overlay is placed.

$in

@CheckReturnValue
@NotNull
default @NotNull QOM.Overlay $in(Field<String> newIn)

The original string on top of which the overlay is placed.

$placing

@NotNull
default @NotNull Field<String> $placing()

The string that is being placed on top of the other string.

$placing

@CheckReturnValue
@NotNull
default @NotNull QOM.Overlay $placing(Field<String> newPlacing)

The string that is being placed on top of the other string.

$startIndex

@NotNull
default @NotNull Field<? extends Number> $startIndex()

The start index (1-based) starting from where the overlay is placed.

$startIndex

@CheckReturnValue
@NotNull
default @NotNull QOM.Overlay $startIndex(Field<? extends Number> newStartIndex)

The start index (1-based) starting from where the overlay is placed.

$length

@Nullable
default @Nullable Field<? extends Number> $length()

The length in the original string that will be replaced, if different from the overlay length.

$length

@CheckReturnValue
@NotNull
default @NotNull QOM.Overlay $length(Field<? extends Number> newLength)

The length in the original string that will be replaced, if different from the overlay length.

$arg1

Field<String> $arg1()

$arg2

Field<String> $arg2()

$arg3

Field<? extends Number> $arg3()

$arg4

Field<? extends Number> $arg4()

$arg1

@CheckReturnValue
@NotNull
default QOM.Overlay $arg1(Field<String> newArg1)

$arg2

@CheckReturnValue
@NotNull
default QOM.Overlay $arg2(Field<String> newArg2)

$arg3

@CheckReturnValue
@NotNull
default QOM.Overlay $arg3(Field<? extends Number> newArg3)

$arg4

@CheckReturnValue
@NotNull
default QOM.Overlay $arg4(Field<? extends Number> newArg4)

$constructor

@NotNull
@NotNull Function4<? super Field<String>,? super Field<String>,? super Field<? extends Number>,? super Field<? extends Number>,? extends QOM.Overlay> $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).

 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.

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