Package dev.frostlake.functions.scalar.string

Class RegexpSubstrAll

java.lang.Object

dev.frostlake.functions.BuiltInFunction

dev.frostlake.functions.TextArgumentFunction

dev.frostlake.functions.scalar.string.RegexpSubstrAll

public class RegexpSubstrAll
extends TextArgumentFunction

REGEXP_SUBSTR_ALL(subject, pattern [, position [, occurrence [, parameters [, group_num]]]]) — returns a VARIANT ARRAY with an element for every match at or after position (1-based, default 1), starting from the occurrence-th match (default 1). With the e flag or an explicit group_num (which implies e), each element is the matching capture group (group 1 by default) rather than the whole match. No matches yields an empty array; any NULL argument yields NULL. REGEXP_EXTRACT_ALL is an exact alias.

Constructor Summary

Constructors

Constructor	Description
RegexpSubstrAll()

Method Summary

Modifier and Type	Method	Description
Object	evaluate(List<Object> args)	Computes the function's result over its already-evaluated argument values.
int	getMaxArgCount()	The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).
int	getMinArgCount()	The fewest arguments a call to this function may pass; fewer is an argument-count error.

Methods inherited from class dev.frostlake.functions.TextArgumentFunction

semiStructuredRejection, vectorRejection

Methods inherited from class dev.frostlake.functions.BuiltInFunction

approximateRejection, binaryRejection, booleanRejection, evaluate, fileRejection, geoRejection, getName, getReturnType, isVariadic, refusesMissingArgumentsByType, structuredRejection, temporalRejection, temporalRejection, temporalRejection, textRejection, uuidRejection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RegexpSubstrAll

public RegexpSubstrAll()

Method Details

evaluate

public Object evaluate(List<Object> args)

Description copied from class: BuiltInFunction

Computes the function's result over its already-evaluated argument values. A SQL NULL argument arrives as Java null, and returning null makes the SQL result NULL.

Specified by:

evaluate in class BuiltInFunction

Parameters:

args - the argument values, in call order

Returns:

the function's value for these arguments, or null for SQL NULL

getMinArgCount

public int getMinArgCount()

Description copied from class: BuiltInFunction

The fewest arguments a call to this function may pass; fewer is an argument-count error.

Specified by:

getMinArgCount in class BuiltInFunction

Returns:

the minimum accepted argument count

getMaxArgCount

public int getMaxArgCount()

Description copied from class: BuiltInFunction

The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).

Specified by:

getMaxArgCount in class BuiltInFunction

Returns:

the maximum accepted argument count