Package org.apache.flink.table.catalog

Class FunctionCatalog.InlineCatalogFunction

java.lang.Object

org.apache.flink.table.catalog.FunctionCatalog.InlineCatalogFunction

All Implemented Interfaces:

CatalogFunction

Enclosing class:

FunctionCatalog

@Internal
public static class FunctionCatalog.InlineCatalogFunction
extends Object
implements CatalogFunction

The CatalogFunction which holds an instantiated UDF.

Constructor Summary

Constructors

Constructor	Description
InlineCatalogFunction(FunctionDefinition definition)

Method Summary

Modifier and Type	Method	Description
CatalogFunction	copy()	Create a deep copy of the function.
String	getClassName()	Get the full name of the class backing the function.
FunctionDefinition	getDefinition()
Optional<String>	getDescription()	Get a brief description of the function.
Optional<String>	getDetailedDescription()	Get a detailed description of the function.
FunctionLanguage	getFunctionLanguage()	Get the language used for the definition of function.
List<ResourceUri>	getFunctionResources()	Get a detailed resource description of the function.
boolean	isGeneric()	Distinguish if the function is a generic function.

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineCatalogFunction

public InlineCatalogFunction(FunctionDefinition definition)

Method Detail

getClassName

public String getClassName()

Description copied from interface: CatalogFunction

Get the full name of the class backing the function.

Specified by:

getClassName in interface CatalogFunction

Returns:

the full name of the class

copy

public CatalogFunction copy()

Description copied from interface: CatalogFunction

Create a deep copy of the function.

Specified by:

copy in interface CatalogFunction

Returns:

a deep copy of "this" instance

getDescription

public Optional<String> getDescription()

Description copied from interface: CatalogFunction

Get a brief description of the function.

Specified by:

getDescription in interface CatalogFunction

Returns:

an optional short description of the function

getDetailedDescription

public Optional<String> getDetailedDescription()

Description copied from interface: CatalogFunction

Get a detailed description of the function.

Specified by:

getDetailedDescription in interface CatalogFunction

Returns:

an optional long description of the function

isGeneric

public boolean isGeneric()

Description copied from interface: CatalogFunction

Distinguish if the function is a generic function.

Specified by:

isGeneric in interface CatalogFunction

Returns:

whether the function is a generic function

getFunctionLanguage

public FunctionLanguage getFunctionLanguage()

Description copied from interface: CatalogFunction

Get the language used for the definition of function.

Specified by:

getFunctionLanguage in interface CatalogFunction

Returns:

the language type of the function definition

getFunctionResources

public List<ResourceUri> getFunctionResources()

Description copied from interface: CatalogFunction

Get a detailed resource description of the function.

Specified by:

getFunctionResources in interface CatalogFunction

Returns:

an ResourceUri list of the function

getDefinition

public FunctionDefinition getDefinition()