Java SDK Documentation  8.1
com.vertica.sdk.UDXObjectCancelable Class Reference

Base class for CANCELABLE Vertica User Defined extensions. More...

Inheritance diagram for com.vertica.sdk.UDXObjectCancelable:
Inheritance graph
Collaboration diagram for com.vertica.sdk.UDXObjectCancelable:
Collaboration graph

Public Member Functions

void cancel (ServerInterface srvInterface)
 
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes)
 
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)
 
boolean isCanceled ()
 
void setup (ServerInterface srvInterface, SizedColumnTypes argTypes)
 

Detailed Description

Base class for CANCELABLE Vertica User Defined extensions.

Member Function Documentation

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

This function is invoked from a different thread when the execution is canceled This baseclass cancel should be called in any override.

void com.vertica.sdk.UDXObject.destroy ( ServerInterface  srvInterface,
SizedColumnTypes  argTypes 
)
inherited

Perform per instance destruction. This function may throw errors

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

void com.vertica.sdk.UDXObject.destroy ( ServerInterface  srvInterface,
SizedColumnTypes  argTypes,
SessionParamWriterMap  udSessionParams 
)
inherited

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

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

Returns true if execution was canceled.

void com.vertica.sdk.UDXObject.setup ( ServerInterface  srvInterface,
SizedColumnTypes  argTypes 
)
inherited

Perform per instance initialization. This function may throw errors.