Package dev.frostlake.functions.scalar.file

Class FlIsDocument

java.lang.Object

dev.frostlake.functions.BuiltInFunction

dev.frostlake.functions.scalar.file.FlIsDocument

public class FlIsDocument
extends BuiltInFunction

FL_IS_DOCUMENT(file) — whether the file's CONTENT_TYPE is one of the document types.

Live-verified: the test is on CONTENT_TYPE alone, by exact case-sensitive match against a closed set (see FileContentTypes) — not the path, not the bytes.

Membership is measured, not guessed: TRUE for text/plain, text/csv, text/html, text/markdown, application/json, application/pdf and the Office types, but FALSE for text/tab-separated-values and text/x-python — so a staged .tsv or .py is NOT a document. FL_IS_DOCUMENT(NULL) is FALSE, never NULL.

Constructor Summary

Constructors

Constructor	Description
FlIsDocument()

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.BuiltInFunction

approximateRejection, binaryRejection, booleanRejection, evaluate, fileRejection, geoRejection, 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

FlIsDocument

public FlIsDocument()

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