Inheritance diagram for com.vertica.sdk.AnalyticFunctionFactory:

Collaboration diagram for com.vertica.sdk.AnalyticFunctionFactory:

Public Member Functions
abstract AnalyticFunction	createAnalyticFunction (ServerInterface srvInterface)

void	getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)

void	getPerInstanceResources (ServerInterface srvInterface, VResources res)

void	getPerInstanceResources (ServerInterface srvInterface, VResources res, SizedColumnTypes argTypes)

abstract void	getPrototype (ServerInterface srvInterface, ColumnTypes argTypes, ColumnTypes returnType)

abstract void	getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType) throws UdfException

UDXType	getUDXFactoryType ()

Protected Attributes
long	libOid

String	sqlName

Detailed Description

Interface for declaring parameters and return types for, and instantiating, an associated AnalyticFunction.

Member Function Documentation

abstract AnalyticFunction com.vertica.sdk.AnalyticFunctionFactory.createAnalyticFunction ( ServerInterface srvInterface )

pure virtual

Called when Vertica needs a new AnalyticFunction object to process a function call.

Note: More than one object may be instantiated per query.

Parameters

srvInterface a ServerInterface object used to communicate with Vertica

Returns: an AnalyticFunction object which implements the UDx API described by this metadata.

void com.vertica.sdk.UDXFactory.getParameterType	(	ServerInterface	srvInterface,
		SizedColumnTypes	parameterTypes
	)

inherited

Function to tell Vertica the name and types of parameters that this function uses. Vertica will use this to warn function callers that certain parameters they provide are not affecting anything, or that certain parameters that are not being set are reverting to default values.

Parameters

srvInterface	a ServerInterface object used to communicate with Vertica
parameterTypes	SizedColumnTypes describing the parameters

void com.vertica.sdk.UDXFactory.getPerInstanceResources	(	ServerInterface	srvInterface,
		VResources	res
	)

inherited

Set the resource required for each instance of the UDX Object subclass

Parameters

srvInterface	a ServerInterface object used to communicate with Vertica
res	a VResources object used to tell Vertica what resources are needed by the UDX

Referenced by com.vertica.sdk.UDXFactory.getPerInstanceResources().

void com.vertica.sdk.UDXFactory.getPerInstanceResources	(	ServerInterface	srvInterface,
		VResources	res,
		SizedColumnTypes	argTypes
	)

inherited

Set the resource required for each instance of the UDX Object subclass

Parameters

srvInterface	a ServerInterface object used to communicate with Vertica
res	a VResources object used to tell Vertica what resources are needed by the UDX
argTypes	Provides the data types of arguments that this UDx was called with. This may be used to calculate the resources required by the UDx.

abstract void com.vertica.sdk.UDXFactory.getPrototype	(	ServerInterface	srvInterface,
		ColumnTypes	argTypes,
		ColumnTypes	returnType
	)

pure virtualinherited

Provides the argument and return types of the UDX

Parameters

srvInterface	a ServerInterface object used to communicate with Vertica
argTypes	the types of the arguments
returnType	the type(s) of the return

Implemented in com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

Referenced by com.vertica.sdk.ScalarFunctionFactory.getReturnType().

abstract void com.vertica.sdk.UDXFactory.getReturnType	(	ServerInterface	srvInterface,
		SizedColumnTypes	argTypes,
		SizedColumnTypes	returnType
	)		throws UdfException

pure virtualinherited

Function to tell Vertica what the return types (and length/precision if necessary) of this UDX are.

For CHAR/VARCHAR types, specify the max length,

For NUMERIC types, specify the precision and scale.

For Time types (with or without time zone), specify the precision, -1 means unspecified/don't care

For IntervalYM/IntervalDS types, specify the precision and range

For all other types, no length/precision specification needed

Parameters

srvInterface	a ServerInterface object used to communicate with Vertica
argTypes	Provides the data types of arguments that this UDT was called with. This may be used to modify the return types accordingly.
returnType	User code must fill in the names and data types returned by the UDT.

Implemented in com.vertica.sdk.ScalarFunctionFactory, com.vertica.sdk.UDLFactory, and com.vertica.sdk.MultiPhaseTransformFunctionFactory.

UDXType com.vertica.sdk.AnalyticFunctionFactory.getUDXFactoryType ( )

virtual

Returns: the object type internally used by Vertica

Implements com.vertica.sdk.UDXFactory.

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation