Package dev.frostlake.functions.scalar.conditional

Class Least

java.lang.Object

dev.frostlake.functions.BuiltInFunction

dev.frostlake.functions.scalar.conditional.Least

public class Least
extends BuiltInFunction

Constructor Summary

Constructors

Constructor	Description
Least()

Method Summary

Modifier and Type	Method	Description
Object	evaluate(List<Object> rawArgs)	Computes the function's result over its already-evaluated argument values.
Object	evaluate(List<Object> args, CollationSpec collation)	Under a collation the arguments are ordered by its rules, so 'a' outranks 'B' where it should.
SemiStructuredRejection	geoRejection(int position)	LEAST orders its arguments and so refuses a GEOSPATIAL one, where it takes an OBJECT — see Greatest.geoRejection(int) for the measurement.
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.BuiltInFunction

approximateRejection, binaryRejection, booleanRejection, fileRejection, getName, getReturnType, isVariadic, refusesMissingArgumentsByType, semiStructuredRejection, structuredRejection, temporalRejection, temporalRejection, temporalRejection, textRejection, uuidRejection, vectorRejection

Methods inherited from class java.lang.Object

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

Constructor Details

Least

public Least()

Method Details

geoRejection

public SemiStructuredRejection geoRejection(int position)

LEAST orders its arguments and so refuses a GEOSPATIAL one, where it takes an OBJECT — see Greatest.geoRejection(int) for the measurement.

Overrides:

geoRejection in class BuiltInFunction

Parameters:

position - the zero-based argument position being asked about

Returns:

the refusal this position gives a GEOGRAPHY or GEOMETRY value; by default, the union of the two semi-structured answers

evaluate

public Object evaluate(List<Object> rawArgs)

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:

rawArgs - 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 arguments are ordered by its rules, so 'a' outranks 'B' where it should.

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