Public member functions documentation

virtual void close()=0
Closes the AE and releases its resources.
Release all resources associated with the function.
virtual NzaeRecord* createOutputRecord() const =0
Create a new output record.
Returns
NzaeRecord
An instance of NzaeRecord with NULL fields.
Creates a new NzaeRecord object compatible for output. To be compatible, the object has the correct number of fields of the correct database type in the correct order.
See also: NzaeRecord.
virtual void done() const =0
Indicates done.
Indicates the AE is finishing successfully, getting no more rows and outputting no more results.
virtual const NzaeEnvironment& getEnvironment() const =0
Gets environment information for the AE.
Returns
NzaeEnvironment
The instance of NzaeEnvironment .
See also: NzaeEnvironment.
virtual const NzaeLibrary& getLibrary() const =0
Gets library information for the AE.
Returns
NzaeLibrary
The instance of NzaeLibrary.
See also: NzaeLibrary.
virtual NzaeFunctionMessageHandler& getMessageHandler() const =0
Returns the message handler class object.
Returns
NzaeFunctionMessageHandler
The instance of NzaeFunctionMessageHandler
The message handler is where custom function logic is implemented.
See also: NzaeFunctionMessageHandler.
virtual const NzaeMetadata& getMetadata() const =0
Gets metadata about the AE including the input and output columns.
Returns
NzaeMetadata
The instance of NzaeMetadata.
See also: NzaeMetadata.
virtual const NzaeParameters& getParameters() const =0
Gets parameter information for the AE.
Returns
NzaeParameters
The instance of NzaeParameters.
See also: NzaeParameters.
virtual const NzaeRuntime& getRuntime() const =0
Gets runtime information for the AE, including information about the Netezza software.
Returns
NzaeRuntime
The instance of NzaeRuntime.
See also: NzaeRuntime.
virtual void log(LogLevel logLevel, const char *message) const =0
Logs the specified message at the given log level.
Parameters
LogLevel logLevel
The log level constant.
message
The message to log.
virtual std::string logFileName() const =0
Returns the log file name.
Returns
The fog file name.
virtual NzaeRecord* next()=0
Gets the next input row.
Returns
NzaeRecord
An instance of NzaeRecord or NULL when there is no more data.
See also: nzaeRecord.
virtual bool nextPartition()=0
Returns TRUE if there is another partition.
Returns
TRUE if there is another partition.
In non-partition mode, the function returns TRUE once at the start of input. In partition mode, if nextPartition has been called, the function returns TRUE at the start of a partition. At the end of a partition, the next function returns NULL, and nextPartition must be called before the next function can return data for the following partition. If nextPartition has never been called, then next returns data for all the partitions.
virtual void outputResult(NzaeRecord &rec)=0
Outputs the record.
Parameters
NzaeRecord rec
An output compatible instance of NzaeRecord .
See also: NzaeRecord.
virtual void ping() const =0
Indicates that the AE is still active and not hanging.
virtual void run(NzaeFunctionMessageHandler *messageHandler)=0
Runs the function handler.
Parameters
NzaeFunctionMessageHandler messageHandler
The message handler.
Begins the Function Message Processing. Processes one row of input and produces one row of output. Used for scalar functions and some table functions. Scalar functions use only one field in the result. This function can be used as an alternative to writing a for loop with next and outputResult. The message handler is where custom logic is implemented.
See also: NzaeFunctionMessageHandler.
virtual void userError(const char *message) const =0
Indicates the AE has encountered an error condition.
Parameters
message
The message to send back to the Netezza software.
Implies NzaeDone.
virtual ~NzaeFunction()