Public member functions

  • void close()

    Close the AE and release resources.

  • 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 the AE.

    Returns

    NzaeEnvironment

    The instance of NzaeEnvironment.

  • boolean getInputInterpretCharAsBinary(int index)

    Get 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.

    TRUE

    = byte array; FALSE = string.

    The default value is FALSE.
  • NzaeLibrary getLibrary()

    Gets library information for the AE.

    Returns

    NzaeLibrary

    The instance of NzaeLibrary.

  • NzaeAggMessageHandler getMessageHandler()

    Returns the message handler class object.

    Returns

    NzaeAggMessageHandler

    The Message Handler.

  • NzaeRuntime getRuntime()

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

    Returns

    NzaeRuntime

    The instance of NzaeRuntime.

  • boolean getStateInterpretCharAsBinary(int index)
  • 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.

  • void ping()

    Indicates that the AE is still active and not hanging.

  • void runAggregation(NzaeAggMessageHandler messageHandler)

    Begin the Aggregation Message Processing.

    Parameters

    NzaeAggMessageHandler

    messageHandler Message Handler.

  • void setInputInterpretCharAsBinary(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.
  • void setStateInterpretCharAsBinary(int index, boolean arg)
  • int type()

    Returns the Aggregate type.

    Returns

    The Aggregate type.

  • void userError(String message)

    Indicates this AE has encountered an error condition.

    Parameters

    message

    The message to send back to the Netezza system.

    Implies NzaeDone.