Inheritance diagram for com.cloudera.impala.catalog.ScalarFunction:

Collaboration diagram for com.cloudera.impala.catalog.ScalarFunction:

Public Member Functions
	ScalarFunction (FunctionName fnName, ArrayList< Type > argTypes, Type retType, boolean hasVarArgs)

	ScalarFunction (FunctionName fnName, List< Type > argTypes, Type retType, HdfsUri location, String symbolName, String initFnSymbol, String closeFnSymbol)

void	setSymbolName (String s)

void	setPrepareFnSymbol (String s)

void	setCloseFnSymbol (String s)

String	getSymbolName ()

String	getPrepareFnSymbol ()

String	getCloseFnSymbol ()

TFunction	toThrift ()

FunctionName	getFunctionName ()

String	functionName ()

String	dbName ()

Type	getReturnType ()

Type[]	getArgs ()

int	getNumArgs ()

HdfsUri	getLocation ()

TFunctionBinaryType	getBinaryType ()

boolean	hasVarArgs ()

boolean	userVisible ()

Type	getVarArgsType ()

void	setName (FunctionName name)

void	setLocation (HdfsUri loc)

void	setBinaryType (TFunctionBinaryType type)

void	setHasVarArgs (boolean v)

void	setUserVisible (boolean b)

String	signatureString ()

boolean	equals (Object o)

boolean	compare (Function other, CompareMode mode)

Function	promoteCharsToStrings ()

Function	selectClosestSuperType (List< Function > candidates)

TCatalogObjectType	getCatalogObjectType ()

long	getCatalogVersion ()

void	setCatalogVersion (long newVersion)

String	getName ()

boolean	isLoaded ()

String	lookupSymbol (String symbol, TSymbolType symbolType, Type retArgType, boolean hasVarArgs, Type...argTypes) throws AnalysisException

String	lookupSymbol (String symbol, TSymbolType symbolType) throws AnalysisException

Static Public Member Functions
static ScalarFunction	createBuiltin (String name, ArrayList< Type > argTypes, boolean hasVarArgs, Type retType, String symbol, String prepareFnSymbol, String closeFnSymbol, boolean isOperator)

static ScalarFunction	createBuiltinOperator (String name, ArrayList< Type > argTypes, Type retType)

static ScalarFunction	createBuiltinOperator (String name, String symbol, ArrayList< Type > argTypes, Type retType)

static ScalarFunction	createBuiltin (String name, String symbol, ArrayList< Type > argTypes, boolean hasVarArgs, Type retType, boolean userVisible)

static ScalarFunction	createBuiltinSearchDesc (String name, Type[] argTypes, boolean hasVarArgs)

static Function	fromThrift (TFunction fn)

static String	getUdfType (Type t)

Private Attributes
String	symbolName_

String	prepareFnSymbol_

String	closeFnSymbol_

Detailed Description

Internal representation of a scalar function.

Definition at line 33 of file ScalarFunction.java.

Constructor & Destructor Documentation

com.cloudera.impala.catalog.ScalarFunction.ScalarFunction	(	FunctionName	fnName,
		ArrayList< Type >	argTypes,
		Type	retType,
		boolean	hasVarArgs
	)

inline

Definition at line 40 of file ScalarFunction.java.

Referenced by com.cloudera.impala.catalog.ScalarFunction.createBuiltin(), and com.cloudera.impala.catalog.ScalarFunction.createBuiltinSearchDesc().

com.cloudera.impala.catalog.ScalarFunction.ScalarFunction	(	FunctionName	fnName,
		List< Type >	argTypes,
		Type	retType,
		HdfsUri	location,
		String	symbolName,
		String	initFnSymbol,
		String	closeFnSymbol
	)

inline

Definition at line 45 of file ScalarFunction.java.

References com.cloudera.impala.catalog.ScalarFunction.setCloseFnSymbol(), com.cloudera.impala.catalog.Function.setLocation(), com.cloudera.impala.catalog.ScalarFunction.setPrepareFnSymbol(), and com.cloudera.impala.catalog.ScalarFunction.setSymbolName().

Member Function Documentation

boolean com.cloudera.impala.catalog.Function.compare	(	Function	other,
		CompareMode	mode
	)

inlineinherited

Definition at line 157 of file Function.java.

References com.cloudera.impala.catalog.Function.isIdentical(), com.cloudera.impala.catalog.Function.isIndistinguishable(), and com.cloudera.impala.catalog.Function.isSuperTypeOf().

Referenced by com.cloudera.impala.catalog.Function.equals().

static ScalarFunction com.cloudera.impala.catalog.ScalarFunction.createBuiltin	(	String	name,
		ArrayList< Type >	argTypes,
		boolean	hasVarArgs,
		Type	retType,
		String	symbol,
		String	prepareFnSymbol,
		String	closeFnSymbol,
		boolean	isOperator
	)

inlinestatic

Creates a builtin scalar function. This is a helper that wraps a few steps into one call.

Definition at line 59 of file ScalarFunction.java.

References com.cloudera.impala.catalog.Catalog.BUILTINS_DB, and com.cloudera.impala.catalog.ScalarFunction.ScalarFunction().

Referenced by com.cloudera.impala.catalog.Db.addScalarBuiltin(), and com.cloudera.impala.catalog.ScalarFunction.createBuiltinOperator().

static ScalarFunction com.cloudera.impala.catalog.ScalarFunction.createBuiltin	(	String	name,
		String	symbol,
		ArrayList< Type >	argTypes,
		boolean	hasVarArgs,
		Type	retType,
		boolean	userVisible
	)

inlinestatic

Definition at line 160 of file ScalarFunction.java.

References com.cloudera.impala.catalog.Catalog.BUILTINS_DB, com.cloudera.impala.catalog.Function.getArgs(), com.cloudera.impala.catalog.ScalarFunction.ScalarFunction(), and com.cloudera.impala.catalog.Function.userVisible().

static ScalarFunction com.cloudera.impala.catalog.ScalarFunction.createBuiltinOperator	(	String	name,
		ArrayList< Type >	argTypes,
		Type	retType
	)

inlinestatic

Creates a builtin scalar operator function. This is a helper that wraps a few steps into one call. TODO: this needs to be kept in sync with what generates the be operator implementations. (gen_functions.py). Is there a better way to coordinate this.

Definition at line 102 of file ScalarFunction.java.

static ScalarFunction com.cloudera.impala.catalog.ScalarFunction.createBuiltinOperator	(	String	name,
		String	symbol,
		ArrayList< Type >	argTypes,
		Type	retType
	)

inlinestatic

Definition at line 155 of file ScalarFunction.java.

References com.cloudera.impala.catalog.ScalarFunction.createBuiltin().

static ScalarFunction com.cloudera.impala.catalog.ScalarFunction.createBuiltinSearchDesc	(	String	name,
		Type[]	argTypes,
		boolean	hasVarArgs
	)

inlinestatic

Create a function that is used to search the catalog for a matching builtin. Only the fields necessary for matching function prototypes are specified.

Definition at line 183 of file ScalarFunction.java.

References com.cloudera.impala.catalog.Catalog.BUILTINS_DB, com.cloudera.impala.catalog.Type.INVALID, and com.cloudera.impala.catalog.ScalarFunction.ScalarFunction().

String com.cloudera.impala.catalog.Function.dbName ( )

inlineinherited

Definition at line 117 of file Function.java.

Referenced by com.cloudera.impala.catalog.Catalog.addFunction(), com.cloudera.impala.service.MetadataOp.createFunctionResultRow(), com.cloudera.impala.catalog.Catalog.getFunction(), and com.cloudera.impala.catalog.Catalog.removeFunction().

boolean com.cloudera.impala.catalog.Function.equals ( Object o )

inlineinherited

Definition at line 151 of file Function.java.

References com.cloudera.impala.catalog.Function.compare(), and com.cloudera.impala.catalog.Function.CompareMode.IS_IDENTICAL.

static Function com.cloudera.impala.catalog.Function.fromThrift ( TFunction fn )

inlinestaticinherited

Definition at line 308 of file Function.java.

References com.cloudera.impala.analysis.FunctionName.fromThrift(), com.cloudera.impala.catalog.Type.fromThrift(), and com.cloudera.impala.catalog.Function.Function().

String com.cloudera.impala.catalog.Function.functionName ( )

inlineinherited

Definition at line 116 of file Function.java.

Referenced by com.cloudera.impala.service.MetadataOp.createFunctionResultRow(), and com.cloudera.impala.catalog.Db.removeFunction().

Type [] com.cloudera.impala.catalog.Function.getArgs ( )

inlineinherited

Definition at line 119 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_.

Referenced by com.cloudera.impala.catalog.ScalarFunction.createBuiltin().

TFunctionBinaryType com.cloudera.impala.catalog.Function.getBinaryType ( )

inlineinherited

Definition at line 123 of file Function.java.

References com.cloudera.impala.catalog.Function.binaryType_.

Referenced by com.cloudera.impala.analysis.FunctionCallExpr.analyze().

TCatalogObjectType com.cloudera.impala.catalog.Function.getCatalogObjectType ( )

inlineinherited

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 283 of file Function.java.

long com.cloudera.impala.catalog.Function.getCatalogVersion ( )

inlineinherited

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 286 of file Function.java.

References com.cloudera.impala.catalog.Function.catalogVersion_.

Referenced by com.cloudera.impala.catalog.ImpaladCatalog.addFunction(), and com.cloudera.impala.catalog.ImpaladCatalog.removeFunction().

String com.cloudera.impala.catalog.ScalarFunction.getCloseFnSymbol ( )

inline

Definition at line 199 of file ScalarFunction.java.

References com.cloudera.impala.catalog.ScalarFunction.closeFnSymbol_.

FunctionName com.cloudera.impala.catalog.Function.getFunctionName ( )

inlineinherited

Definition at line 115 of file Function.java.

References com.cloudera.impala.catalog.Function.name_.

Referenced by com.cloudera.impala.catalog.CatalogServiceCatalog.addFunction(), and com.cloudera.impala.catalog.Function.getName().

HdfsUri com.cloudera.impala.catalog.Function.getLocation ( )

inlineinherited

Definition at line 122 of file Function.java.

References com.cloudera.impala.catalog.Function.location_.

String com.cloudera.impala.catalog.Function.getName ( )

inlineinherited

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 292 of file Function.java.

References com.cloudera.impala.catalog.Function.getFunctionName().

int com.cloudera.impala.catalog.Function.getNumArgs ( )

inlineinherited

Definition at line 121 of file Function.java.

Referenced by com.cloudera.impala.analysis.CreateUdaStmt.analyze(), com.cloudera.impala.catalog.Function.isIndistinguishable(), and com.cloudera.impala.analysis.Expr.treeToThriftHelper().

String com.cloudera.impala.catalog.ScalarFunction.getPrepareFnSymbol ( )

inline

Definition at line 198 of file ScalarFunction.java.

References com.cloudera.impala.catalog.ScalarFunction.prepareFnSymbol_.

Type com.cloudera.impala.catalog.Function.getReturnType ( )

inlineinherited

Definition at line 118 of file Function.java.

References com.cloudera.impala.catalog.Function.retType_.

Referenced by com.cloudera.impala.analysis.CreateUdaStmt.analyze(), com.cloudera.impala.catalog.AggregateFunction.toThrift(), and com.cloudera.impala.catalog.Function.toThrift().

String com.cloudera.impala.catalog.ScalarFunction.getSymbolName ( )

inline

Definition at line 197 of file ScalarFunction.java.

References com.cloudera.impala.catalog.ScalarFunction.symbolName_.

static String com.cloudera.impala.catalog.Function.getUdfType ( Type t )

inlinestaticinherited

Definition at line 401 of file Function.java.

References com.cloudera.impala.catalog.Type.getPrimitiveType().

Type com.cloudera.impala.catalog.Function.getVarArgsType ( )

inlineinherited

Definition at line 126 of file Function.java.

References com.cloudera.impala.catalog.Function.argTypes_, com.cloudera.impala.catalog.Function.hasVarArgs_, and com.cloudera.impala.catalog.Type.INVALID.

Referenced by com.cloudera.impala.catalog.Function.isIndistinguishable().

boolean com.cloudera.impala.catalog.Function.hasVarArgs ( )

inlineinherited

Definition at line 124 of file Function.java.

References com.cloudera.impala.catalog.Function.hasVarArgs_.

Referenced by com.cloudera.impala.analysis.CreateUdaStmt.analyze(), com.cloudera.impala.catalog.Function.lookupSymbol(), and com.cloudera.impala.analysis.Expr.treeToThriftHelper().

boolean com.cloudera.impala.catalog.Function.isLoaded ( )

inlineinherited

Implements com.cloudera.impala.catalog.CatalogObject.

Definition at line 342 of file Function.java.

String com.cloudera.impala.catalog.Function.lookupSymbol	(	String	symbol,
		TSymbolType	symbolType,
		Type	retArgType,
		boolean	hasVarArgs,
		Type...	argTypes
	)		throws AnalysisException