Package org.apache.flink.table.catalog
Class CatalogFunctionImpl
- java.lang.Object
-
- org.apache.flink.table.catalog.CatalogFunctionImpl
-
- All Implemented Interfaces:
CatalogFunction
@Internal public class CatalogFunctionImpl extends Object implements CatalogFunction
A catalog function implementation.
-
-
Constructor Summary
Constructors Constructor Description CatalogFunctionImpl(String className)
CatalogFunctionImpl(String className, FunctionLanguage functionLanguage)
CatalogFunctionImpl(String className, FunctionLanguage functionLanguage, List<ResourceUri> resourceUris)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CatalogFunction
copy()
Create a deep copy of the function.boolean
equals(Object o)
String
getClassName()
Get the full name of the class backing the function.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.int
hashCode()
boolean
isGeneric()
Distinguish if the function is a generic function.String
toString()
-
-
-
Constructor Detail
-
CatalogFunctionImpl
public CatalogFunctionImpl(String className)
-
CatalogFunctionImpl
public CatalogFunctionImpl(String className, FunctionLanguage functionLanguage)
-
CatalogFunctionImpl
public CatalogFunctionImpl(String className, FunctionLanguage functionLanguage, List<ResourceUri> resourceUris)
-
-
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 interfaceCatalogFunction
- 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 interfaceCatalogFunction
- 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 interfaceCatalogFunction
- 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 interfaceCatalogFunction
- 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 interfaceCatalogFunction
- 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 interfaceCatalogFunction
- 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 interfaceCatalogFunction
- Returns:
- an
ResourceUri
list of the function
-
-