Package dev.frostlake.functions.scalar.string

Class CharIndex

java.lang.Object

dev.frostlake.functions.BuiltInFunction

dev.frostlake.functions.TextArgumentFunction

dev.frostlake.functions.scalar.string.CharIndex

public class CharIndex
extends TextArgumentFunction

CHARINDEX(needle, haystack [, start]) — POSITION's argument order; BINARY pairs search by BYTE.

Constructor Summary

Constructors

Constructor	Description
CharIndex()

Method Summary

Modifier and Type	Method	Description
Object	evaluate(List<Object> args)	Computes the function's result over its already-evaluated argument values.
Object	evaluate(List<Object> args, CollationSpec collation)	Under a collation the needle is found where the collation matches it, not byte for byte.
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, 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

CharIndex

public CharIndex()

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

evaluate

public Object evaluate(List<Object> args,
 CollationSpec collation)

Under a collation the needle is found where the collation matches it, not byte for byte.

Overrides:

evaluate in class BuiltInFunction

Parameters:

args - the argument values, in call order

collation - the collation the call settled on, or null when it carries none

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