Package se.kuseman.payloadbuilder.api.catalog

Enum Class FunctionInfo.FunctionType

java.lang.Object

java.lang.Enum<FunctionInfo.FunctionType>

se.kuseman.payloadbuilder.api.catalog.FunctionInfo.FunctionType

All Implemented Interfaces:

Serializable, Comparable<FunctionInfo.FunctionType>, Constable

Enclosing class:

FunctionInfo

public static enum FunctionInfo.FunctionType
extends Enum<FunctionInfo.FunctionType>

Function type

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AGGREGATE	A scalar function used in aggregations returning a scalar value from groups of values
OPERATOR	An operator function used in operators that supports transforming input stream to a scalar value.
SCALAR	A scalar function used in expressions returning a scalar value.
SCALAR_AGGREGATE	A scalar function that act as both scalar and aggregate depending on context.
TABLE	A table valued function used in function scans return a stream of TupleVector

Method Summary

Modifier and Type	Method	Description
boolean	isAggregate()	Return true if this type is of aggregate type
static FunctionInfo.FunctionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FunctionInfo.FunctionType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SCALAR

public static final FunctionInfo.FunctionType SCALAR

A scalar function used in expressions returning a scalar value.

AGGREGATE

public static final FunctionInfo.FunctionType AGGREGATE

A scalar function used in aggregations returning a scalar value from groups of values

SCALAR_AGGREGATE

public static final FunctionInfo.FunctionType SCALAR_AGGREGATE

A scalar function that act as both scalar and aggregate depending on context.

TABLE

public static final FunctionInfo.FunctionType TABLE

A table valued function used in function scans return a stream of TupleVector

OPERATOR

public static final FunctionInfo.FunctionType OPERATOR

An operator function used in operators that supports transforming input stream to a scalar value. Ie. FOR clause

Method Details

values

public static FunctionInfo.FunctionType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FunctionInfo.FunctionType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isAggregate

public boolean isAggregate()

Return true if this type is of aggregate type