com.vertica.sdk.DefaultSourceIterator Class Reference

Inheritance diagram for com.vertica.sdk.DefaultSourceIterator:

Collaboration diagram for com.vertica.sdk.DefaultSourceIterator:

Public Member Functions
	DefaultSourceIterator (ArrayList< UDSource > sources)
final void	cancelUDX (ServerInterface srvInterface)
UnsizedUDSource	createNextSource (ServerInterface srvInterface)
void	destroy (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException
int	getNumberOfSources ()
Integer	getSizeOfSource (int sourceNum)
boolean	isCanceled ()
void	setup (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException

Protected Member Functions
void	cancel (ServerInterface srvInterface)

Member Function Documentation

cancel()

void com.vertica.sdk.UDXObject.cancel ( ServerInterface  srvInterface )

protectedinherited

Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

• This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.
• This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.
• This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.

Parameters

srvInterface

a ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

cancelUDX()

final void com.vertica.sdk.UDXObject.cancelUDX ( ServerInterface  srvInterface )

inherited

Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters

srvInterface

a ServerInterface object used to communicate with Vertica

destroy()

void com.vertica.sdk.SourceIterator.destroy ( ServerInterface  srvInterface, NodeSpecifyingPlanContext  planCtxt  ) throws UdfException

inherited

Tear down this SourceIterator

Should perform clean-up

Parameters

srvInterface	a ServerInterface object used to communicate with Vertica
planCtxt	a plan context

Exceptions

UdfException

UDF problem

isCanceled()

boolean com.vertica.sdk.UDXObject.isCanceled ( )

inherited

Returns

true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

setup()

void com.vertica.sdk.SourceIterator.setup ( ServerInterface  srvInterface, NodeSpecifyingPlanContext  planCtxt  ) throws UdfException

inherited

Set up this SourceIterator

Should perform setup that should not take place in the constructor due to the exception-handling semantics of constructors

Parameters

srvInterface	a ServerInterface object used to communicate with Vertica
planCtxt	a plan context

Exceptions

UdfException

UDF problem