Package org.apache.drill.exec.expr.fn

Class FunctionAttributes

java.lang.Object

org.apache.drill.exec.expr.fn.FunctionAttributes

public class FunctionAttributes
extends Object

Attributes of a function used in code generation and optimization. Represents the values contained in the annotations of a Drill function.

Constructor Summary

Constructors

Constructor	Description
FunctionAttributes(FunctionTemplate template, ValueReference[] parameters, ValueReference returnValue, WorkspaceReference[] workspaceVars)

Method Summary

Modifier and Type	Method	Description
boolean	checkPrecisionRange()
FunctionTemplate.FunctionCostCategory	getCostCategory()
FunctionTemplate.NullHandling	getNullHandling()
FunctionTemplate.OutputWidthCalculatorType	getOutputWidthCalculatorType()
ValueReference[]	getParameters()
String[]	getRegisteredNames()
FunctionTemplate.ReturnType	getReturnType()
ValueReference	getReturnValue()
FunctionTemplate.FunctionScope	getScope()
WorkspaceReference[]	getWorkspaceVars()
boolean	isBinaryCommutative()
boolean	isDeterministic()
boolean	isInternal()
boolean	isNiladic()
boolean	isRandom()	Deprecated.
boolean	isVarArg()
int	variableOutputSizeEstimate()

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionAttributes

public FunctionAttributes(FunctionTemplate template,
 ValueReference[] parameters,
 ValueReference returnValue,
 WorkspaceReference[] workspaceVars)

Method Details

getScope

public FunctionTemplate.FunctionScope getScope()

getReturnType

public FunctionTemplate.ReturnType getReturnType()

getOutputWidthCalculatorType

public FunctionTemplate.OutputWidthCalculatorType getOutputWidthCalculatorType()

variableOutputSizeEstimate

public int variableOutputSizeEstimate()

getNullHandling

public FunctionTemplate.NullHandling getNullHandling()

isBinaryCommutative

public boolean isBinaryCommutative()

isRandom

@Deprecated
public boolean isRandom()

Deprecated.

isDeterministic

public boolean isDeterministic()

getRegisteredNames

public String[] getRegisteredNames()

getParameters

public ValueReference[] getParameters()

getReturnValue

public ValueReference getReturnValue()

getWorkspaceVars

public WorkspaceReference[] getWorkspaceVars()

getCostCategory

public FunctionTemplate.FunctionCostCategory getCostCategory()

isNiladic

public boolean isNiladic()

isVarArg

public boolean isVarArg()

isInternal

public boolean isInternal()

checkPrecisionRange

public boolean checkPrecisionRange()