CustomCursor

The CustomCursor interface returns a cursor type. All custom cursors must implement this interface.

public interface CustomCursor

A custom procedure with just one output cursor can implement both the CustomProcedure and the CustomCursor interfaces to avoid needing another class. A custom procedure with more than one output cursor should use inner classes or separate classes.

Class Summary
ExecutionEnvironment	Lets a procedure interact with the TDV Server.

 

Method Summary
void	close Frees the resources.
ParameterInfo[]	getColumnInfo Returns the metadata for the cursor.
Object[]	next Returns the next row, or NULL when done.

Method Detail

close

public void close()

This method is called to free resources. Calling this method multiple times has no effect, and no exception is thrown.

Throws

This method throws CustomProcedureException.

 

getColumnInfo

public ParameterInfo[] getColumnInfo()

This method is called to get the metadata for the custom cursor.

Returns

This method returns the metadata for the cursor. A NULL value might be returned to indicate that the caller should retrieve the metadata information by calling ProcedureReference.getParameterInfo.

Throws

This method throws CustomProcedureException if the cursor has been closed. This method throws CustomProcedureException or SQLException if an error occurs while fetching the metadata.

 

next

public Object[] next()

This method is called when more metadata is needed.

Returns

This method returns the next row, or NULL when done.

Throws

This method throws CustomProcedureException if the cursor has been closed. This method throws CustomProcedureException or SQLException if an error occurs while fetching the metadata.