Package org.apache.gravitino.function

Class FunctionDefinitions

java.lang.Object

org.apache.gravitino.function.FunctionDefinitions

public final class FunctionDefinitions
extends Object

Helper methods to create FunctionDefinition instances.

Method Summary

Modifier and Type	Method	Description
static FunctionDefinition[]	of(FunctionDefinition... definitions)	Create an array of FunctionDefinition instances.
static FunctionDefinition	of(FunctionParam[] parameters, FunctionColumn[] returnColumns, FunctionImpl[] impls)	Create a FunctionDefinition instance for a table-valued function.
static FunctionDefinition	of(FunctionParam[] parameters, FunctionImpl[] impls)	Deprecated. Use of(FunctionParam[], Type, FunctionImpl[]) or of(FunctionParam[], FunctionColumn[], FunctionImpl[]) instead.
static FunctionDefinition	of(FunctionParam[] parameters, Type returnType, FunctionImpl[] impls)	Create a FunctionDefinition instance for a scalar or aggregate function.

Methods inherited from class java.lang.Object

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

Method Details

of

public static FunctionDefinition[] of(FunctionDefinition... definitions)

Create an array of FunctionDefinition instances.

Parameters:

definitions - The function definitions.

Returns:

An array of FunctionDefinition instances.

of

public static FunctionDefinition of(FunctionParam[] parameters,
 Type returnType,
 FunctionImpl[] impls)

Create a FunctionDefinition instance for a scalar or aggregate function.

Parameters:

parameters - The parameters for this definition, it may be null or empty.

returnType - The return type for this definition, it must not be null.

impls - The implementations for this definition, it must not be null or empty.

Returns:

A FunctionDefinition instance.

of

public static FunctionDefinition of(FunctionParam[] parameters,
 FunctionColumn[] returnColumns,
 FunctionImpl[] impls)

Create a FunctionDefinition instance for a table-valued function.

Parameters:

parameters - The parameters for this definition, it may be null or empty.

returnColumns - The return columns for this definition, it must not be null or empty.

impls - The implementations for this definition, it must not be null or empty.

Returns:

A FunctionDefinition instance.

of

@Deprecated
public static FunctionDefinition of(FunctionParam[] parameters,
 FunctionImpl[] impls)

Deprecated.

Use of(FunctionParam[], Type, FunctionImpl[]) or of(FunctionParam[], FunctionColumn[], FunctionImpl[]) instead.

Create a FunctionDefinition instance. This method is kept for backward compatibility.

Parameters:

parameters - The parameters for this definition, it may be null or empty.

impls - The implementations for this definition, it must not be null or empty.

Returns:

A FunctionDefinition instance.