org.apache.hadoop.hive.ql.udf

Interface SettableUDF

All Known Implementing Classes:

GenericUDFToChar, GenericUDFToDecimal, GenericUDFToTimestampLocalTZ, GenericUDFToVarchar

public interface SettableUDF

THIS INTERFACE IS UNSTABLE AND SHOULD NOT BE USED BY 3RD PARTY UDFS. Interface to allow passing of parameters to the UDF, before it is initialized. For example, to be able to pass the char length parameters to a char type cast.

Method Summary

Modifier and Type	Method and Description
TypeInfo	getTypeInfo()
void	setTypeInfo(TypeInfo typeInfo) Add data to UDF prior to initialization.

Method Detail

setTypeInfo

void setTypeInfo(TypeInfo typeInfo)
          throws UDFArgumentException

Add data to UDF prior to initialization. An exception may be thrown if the UDF doesn't know what to do with this data.

Parameters:

params - UDF-specific data to add to the UDF

Throws:

UDFArgumentException

getTypeInfo

TypeInfo getTypeInfo()