Public member functions

  • void close()

    Closes the AE and releases its resources.

  • NzaeRecord createOutputRecord()

    Creates a new NzaeRecord object compatible for output.

    Returns

    NzaeRecord

    An instance of NzaeRecord with NULL fields.

    An object is compatible if it has the correct number of fields of the correct database type in the correct order.

  • void done()

    Indicates the AE is finishing successfully and does not get any more rows or output any more results.

  • int getApiType()

    Returns the API Constant for this interface.

    Returns

    The values defined in NzaeApi.

  • NzaeDataTypes getDataTypes()

    Gets the NZ Data Type constants.

    Returns

    NzaeDataTypes

    The instance of NzaeDataTypes .

  • NzaeEnvironment getEnvironment()

    Gets environment information for the AE.

    Returns

    NzaeEnvironment

    This instance of NzaeEnvironment.

  • boolean getInterpretCharAsBinary(int index)

    Gets the TRUE / FALSE state of the interpretation mode of a char or varchar column as a byte array.

    Parameters

    index

    The column index, which is 0 based.

    Returns

    TRUE = byte array; FALSE = string.

    The default value is FALSE.

  • NzaeLibrary getLibrary()

    Gets the library information for the AE.

    Returns

    NzaeLibrary

    The instance of NzaeLibrary.

  • NzaeMessageHandler getMessageHandler()

    Returns the message handler class object.

    Returns

    NzaeMessageHandler

    The instance of NzaeFunctionMessageHandler.

  • NzaeMetadata getMetadata()

    Gets metadata about the AE, including the input and output columns.

    Returns

    NzaeMetadata

    The instance of NzaeMetadata.

  • NzaeRuntime getRuntime()

    Gets runtime information the AE, including information about the Netezza system.

    Returns

    NzaeRuntime

    The instance of NzaeRuntime.

  • void log(int logLevel, String message)

    Logs the specified message at the specified log level.

    Parameters

    logLevel

    The log level constant.

    message

    The message to log.

  • NzaeRecord next()

    Gets the next input row.

    Returns

    NzaeRecord

    An instance of NzaeRecord or NULL when there is no more data.

  • boolean nextPartition()

    Gets the next partition.

    Returns

    TRUE if there is another partition; otherwise FALSE.

  • void outputResult(NzaeRecord rec)

    Outputs the record.

    Parameters

    NzaeRecord rec

    An output compatible instance of Rerecord.

  • void ping()

    Indicates that the AE is still active and not hanging.

  • void run(NzaeMessageHandler messageHandler)

    Begins higher level function message processing.

    Parameters

    NzaeMessageHandler

    messageHandler The message handler.

    Processes one row of input and produces one row of output. Used for all scalar functions and some table functions. Scalar functions use a single field in the result.

    This is an alternative to writing a custom for loop using next and outputResult.

  • void setInterpretCharAsBinary(int index, boolean arg)

    Interprets a char or varchar column as a byte array.

    Parameters

    index

    The column index, which is 0 based.

    arg

    TRUE = byte array; FALSE = string.

    The default value is FALSE.

  • int size()

    Gets the field size.

    Returns

    The field size.

  • void userError(String message)

    Indicates the AE has encountered an error condition.

    Parameters

    message

    The message to send back to the Netezza system.

    Implies NzaeDone.