Java SDK Documentation
12.0.0
|
Public Member Functions | |
final void | cancelUDX (ServerInterface srvInterface) |
abstract UnsizedUDSource | createNextSource (ServerInterface srvInterface) throws UdfException |
void | destroy (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException |
abstract int | getNumberOfSources () throws UdfException |
Integer | getSizeOfSource (int sourceNum) throws UdfException |
boolean | isCanceled () |
void | setup (ServerInterface srvInterface, NodeSpecifyingPlanContext planCtxt) throws UdfException |
Protected Member Functions | |
void | cancel (ServerInterface srvInterface) |
Constructs a set of Sources to be used by an IterativeSourceFactory.
createNextSource() will be called repeatedly until it returns NULL. Each resulting Source will be read to completion, and the contained data passed to the Filter and Parser.
|
protectedinherited |
Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.
srvInterface | a ServerInterface object used to communicate with Vertica |
Referenced by com.vertica.sdk.UDXObject.cancelUDX().
|
inherited |
Cancel callback invoked when the query running the UDX has been canceled.
See cancel().
srvInterface | a ServerInterface object used to communicate with Vertica |
|
pure virtual |
Create the next UDSource to process.
Should return NULL if no further sources are available for processing.
Note that the previous Source may still be open and in use on a different thread when this function is called.
srvInterface | a ServerInterface object used to communicate with Vertica |
UdfException | UDF problem |
Implemented in com.vertica.sdk.DefaultSourceIterator.
void com.vertica.sdk.SourceIterator.destroy | ( | ServerInterface | srvInterface, |
NodeSpecifyingPlanContext | planCtxt | ||
) | throws UdfException |
Tear down this SourceIterator
Should perform clean-up
srvInterface | a ServerInterface object used to communicate with Vertica |
planCtxt | a plan context |
UdfException | UDF problem |
|
pure virtual |
UdfException | UDF problem |
Implemented in com.vertica.sdk.DefaultSourceIterator.
Integer com.vertica.sdk.SourceIterator.getSizeOfSource | ( | int | sourceNum | ) | throws UdfException |
sourceNum | which source to query |
vint_null
if the size is unknown. This value is used as a hint, and is used by the "load_streams" table to display load progress. If incorrect or not set, "load_streams" may contain incorrect or unhelpful information.
UdfException | UDF problem |
|
inherited |
Referenced by com.vertica.sdk.UDXObject.cancelUDX().
void com.vertica.sdk.SourceIterator.setup | ( | ServerInterface | srvInterface, |
NodeSpecifyingPlanContext | planCtxt | ||
) | throws UdfException |
Set up this SourceIterator
Should perform setup that should not take place in the constructor due to the exception-handling semantics of constructors
srvInterface | a ServerInterface object used to communicate with Vertica |
planCtxt | a plan context |
UdfException | UDF problem |