org.apache.drill.exec.expr.annotations

Annotation Type FunctionTemplate

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface FunctionTemplate

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
FunctionTemplate.FunctionScope	scope

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
FunctionTemplate.FunctionCostCategory	costCategory
boolean	isBinaryCommutative
boolean	isRandom
String	name Name of function (when only one.) Use this annotation element if there is only one name for the function.
String[]	names Names of function (when multiple).
FunctionTemplate.NullHandling	nulls

Element Detail

scope

public abstract FunctionTemplate.FunctionScope scope

name

public abstract String name

Name of function (when only one.) Use this annotation element if there is only one name for the function. Note: If you use this annotation don't use names().

TODO: Refer to wherever list of possible or at least known names is, to resolve the current issue of spaces vs. underlines in names (e.g., we have both "less_than" and "less than".

Returns:

Default:

""

names

public abstract String[] names

Names of function (when multiple). Use this annotation element if there are multiple names for the function. Note: If you use this annotation don't use name().

TODO: Refer to wherever list of possible or at least known names is, to resolve the current issue of spaces vs. underlines in names (e.g., we have both "less_than" and "less than".

Returns:

Default:

{}

nulls

public abstract FunctionTemplate.NullHandling nulls

Default:

org.apache.drill.exec.expr.annotations.FunctionTemplate.NullHandling.INTERNAL

isBinaryCommutative

public abstract boolean isBinaryCommutative

Default:

false

isRandom

public abstract boolean isRandom

Default:

false

costCategory

public abstract FunctionTemplate.FunctionCostCategory costCategory

Default:

org.apache.drill.exec.expr.annotations.FunctionTemplate.FunctionCostCategory.SIMPLE