Inheritance diagram for com.vertica.sdk.FilterFactory:

Collaboration diagram for com.vertica.sdk.FilterFactory:

Public Member Functions
void	getParameterType (ServerInterface srvInterface, SizedColumnTypes parameterTypes)

void	getPerInstanceResources (ServerInterface srvInterface, VResources res)

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

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

void	getReturnType (ServerInterface srvInterface, SizedColumnTypes argTypes, SizedColumnTypes returnType)

UDXType	getUDXFactoryType ()

void	plan (ServerInterface srvInterface, PlanContext planCtxt) throws UdfException

abstract UDFilter	prepare (ServerInterface srvInterface, PlanContext planCtxt) throws UdfException

Protected Attributes
long	libOid

String	sqlName

Detailed Description

Produces and initializes UDFilters to transform input data before parsing.

Note that FilterFactories are singletons. Subclasses should be stateless, with no fields containing data, just methods. plan() and prepare() methods must never modify any global variables or state; they may only modify the variables that they are given as arguments.

Member Function Documentation

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.UDLFactory.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.

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

virtualinherited

Provides the argument and return types of the UDL. UDL's take no input tuples; as such, their prototype is empty.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.UDLFactory.getReturnType	(	ServerInterface	srvInterface,
		SizedColumnTypes	argTypes,
		SizedColumnTypes	returnType
	)

virtualinherited

Not used in this form

Implements com.vertica.sdk.UDXFactory.

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

virtual

User subclasses should use the appropriate subclass of UDXFactory and not override this method on their own.

Returns: the type of UDX Object instance this factory returns.

Implements com.vertica.sdk.UDXFactory.

void com.vertica.sdk.FilterFactory.plan	(	ServerInterface	srvInterface,
		PlanContext	planCtxt
	)		throws UdfException

Execute any planning logic required at query plan time. This method is run once per query, during query initialization. Its job is to perform parameter validation, and to modify the set of nodes that the COPY statement will run on (through srvInterface).

plan() runs exactly once per query, on the initiator node. If it throws an exception, the query will not proceed; it will be aborted prior to distributing the query to the other nodes and running prepare().

Parameters

srvInterface	Interface to server operations and functionality, including (not-per-column) parameter lookup
planCtxt	Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().

Exceptions

UdfException UDF problem

abstract UDFilter com.vertica.sdk.FilterFactory.prepare	(	ServerInterface	srvInterface,
		PlanContext	planCtxt
	)		throws UdfException

pure virtual

Initialize a UDFilter. This function will be called on each node, prior to the Load operator starting to execute.

Parameters

srvInterface	Interface to server operations and functionality, including (not-per-column) parameter lookup
planCtxt	Context for storing and retrieving arbitrary data, for use just by this instance of this query. The same context is shared with plan().

Returns: UDFilter instance to use for this query

Exceptions

UdfException UDF problem

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation