org.apache.calcite.schema

Interface FunctionParameter

public interface FunctionParameter

Parameter to a Function.

NOTE: We'd have called it Parameter but the overlap with Parameter was too confusing.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Name of the parameter.
int	getOrdinal() Zero-based ordinal of this parameter within the member's parameter list.
RelDataType	getType(RelDataTypeFactory typeFactory) Returns the type of this parameter.

Method Detail

getOrdinal

int getOrdinal()

Zero-based ordinal of this parameter within the member's parameter list.

Returns:

Parameter ordinal

getName

String getName()

Name of the parameter.

Returns:

Parameter name

getType

RelDataType getType(RelDataTypeFactory typeFactory)

Returns the type of this parameter.

Parameters:

typeFactory - Type factory to be used to create the type

Returns:

Parameter type.