org.apache.hadoop.hive.ql.exec

Class FunctionInfo

java.lang.Object

org.apache.hadoop.hive.ql.exec.FunctionInfo

Direct Known Subclasses:

HiveFunctionInfo, WindowFunctionInfo

public class FunctionInfo
extends Object

FunctionInfo.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FunctionInfo.FunctionResource
static class	FunctionInfo.FunctionType

Field Summary

Fields

Modifier and Type	Field and Description
protected GenericUDF	genericUDF
protected GenericUDTF	genericUDTF

Constructor Summary

Constructors

Constructor and Description
FunctionInfo(FunctionInfo.FunctionType functionType, String displayName, Class<? extends TableFunctionResolver> tFnCls, FunctionInfo.FunctionResource... resources)
FunctionInfo(FunctionInfo.FunctionType functionType, String displayName, Class<? extends TableFunctionResolver> tFnCls, GenericUDF genericUDF, GenericUDTF genericUDTF, GenericUDAFResolver genericUDAFResolver, String className, FunctionInfo.FunctionResource... resources)
FunctionInfo(FunctionInfo.FunctionType functionType, String displayName, GenericUDAFResolver genericUDAFResolver, FunctionInfo.FunctionResource... resources)
FunctionInfo(FunctionInfo.FunctionType functionType, String displayName, GenericUDF genericUDF, FunctionInfo.FunctionResource... resources)
FunctionInfo(FunctionInfo.FunctionType functionType, String displayName, GenericUDTF genericUDTF, FunctionInfo.FunctionResource... resources)
FunctionInfo(String displayName, String className, FunctionInfo.FunctionResource... resources)

Method Summary

Modifier and Type	Method and Description
void	discarded()
String	getClassName()
String	getDisplayName() Get the display name for this function.
Class<?>	getFunctionClass() Get the Class of the UDF.
FunctionInfo.FunctionType	getFunctionType()
GenericUDAFResolver	getGenericUDAFResolver() Get the GenericUDAFResolver object for the function.
GenericUDF	getGenericUDF() Get a new GenericUDF object for the function.
GenericUDTF	getGenericUDTF() Get a new GenericUDTF object for the function.
FunctionInfo.FunctionResource[]	getResources()
Class<? extends TableFunctionResolver>	getTableFunctionResolver()
boolean	isBlockedFunction()
boolean	isBuiltIn()
boolean	isDiscarded()
boolean	isGenericUDAF()
boolean	isGenericUDF()
boolean	isGenericUDTF()
boolean	isInternalTableFunction() Internal table functions cannot be used in the language.
boolean	isNative() Native functions cannot be unregistered.
boolean	isPersistent()
boolean	isTableFunction()
void	setBlockedFunction(boolean blockedFunction)
void	setClassName(String className)
void	shareStateWith(FunctionInfo function)

Methods inherited from class java.lang.Object

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

Field Detail

genericUDF

protected GenericUDF genericUDF

genericUDTF

protected GenericUDTF genericUDTF

Constructor Detail

FunctionInfo

public FunctionInfo(String displayName,
                    String className,
                    FunctionInfo.FunctionResource... resources)

FunctionInfo

public FunctionInfo(FunctionInfo.FunctionType functionType,
                    String displayName,
                    GenericUDF genericUDF,
                    FunctionInfo.FunctionResource... resources)

FunctionInfo

public FunctionInfo(FunctionInfo.FunctionType functionType,
                    String displayName,
                    GenericUDAFResolver genericUDAFResolver,
                    FunctionInfo.FunctionResource... resources)

FunctionInfo

public FunctionInfo(FunctionInfo.FunctionType functionType,
                    String displayName,
                    GenericUDTF genericUDTF,
                    FunctionInfo.FunctionResource... resources)

FunctionInfo

public FunctionInfo(FunctionInfo.FunctionType functionType,
                    String displayName,
                    Class<? extends TableFunctionResolver> tFnCls,
                    FunctionInfo.FunctionResource... resources)

FunctionInfo

public FunctionInfo(FunctionInfo.FunctionType functionType,
                    String displayName,
                    Class<? extends TableFunctionResolver> tFnCls,
                    GenericUDF genericUDF,
                    GenericUDTF genericUDTF,
                    GenericUDAFResolver genericUDAFResolver,
                    String className,
                    FunctionInfo.FunctionResource... resources)

Method Detail

getGenericUDF

public GenericUDF getGenericUDF()

Get a new GenericUDF object for the function.

getGenericUDTF

public GenericUDTF getGenericUDTF()

Get a new GenericUDTF object for the function.

getGenericUDAFResolver

public GenericUDAFResolver getGenericUDAFResolver()

Get the GenericUDAFResolver object for the function.

getFunctionClass

public Class<?> getFunctionClass()

Get the Class of the UDF.

getDisplayName

public String getDisplayName()

Get the display name for this function. This should be transferred into exprNodeGenericUDFDesc, and will be used as the first parameter to GenericUDF.getDisplayName() call, instead of hard-coding the function name. This will solve the problem of displaying only one name when a udf is registered under 2 names.

isNative

public boolean isNative()

Native functions cannot be unregistered.

isInternalTableFunction

public boolean isInternalTableFunction()

Internal table functions cannot be used in the language. WindowingTableFunction

isGenericUDF

public boolean isGenericUDF()

Returns:

TRUE if the function is a GenericUDF

isGenericUDAF

public boolean isGenericUDAF()

Returns:

TRUE if the function is a GenericUDAF

isGenericUDTF

public boolean isGenericUDTF()

Returns:

TRUE if the function is a GenericUDTF

getTableFunctionResolver

public Class<? extends TableFunctionResolver> getTableFunctionResolver()

isTableFunction

public boolean isTableFunction()

Returns:

TRUE if the function is a Table Function

isBlockedFunction

public boolean isBlockedFunction()

setBlockedFunction

public void setBlockedFunction(boolean blockedFunction)

isBuiltIn

public boolean isBuiltIn()

isPersistent

public boolean isPersistent()

getClassName

public String getClassName()

setClassName

public void setClassName(String className)

getResources

public FunctionInfo.FunctionResource[] getResources()

discarded

public void discarded()

isDiscarded

public boolean isDiscarded()

shareStateWith

public void shareStateWith(FunctionInfo function)

getFunctionType

public FunctionInfo.FunctionType getFunctionType()