- virtual void close()=0
- Closes the AE and releases its resources.
- Releases all resources associated with the aggregate.
- virtual const NzaeEnvironment& getEnvironment() const =0
- Gets environment information for the AE.
- Returns
- NzaeEnvironment
- The instance of NzaeEnvironment .
- virtual const NzaeLibrary& getLibrary() const =0
- Gets library information for the AE.
- Returns
- NzaeLibrary
- The instance of NzaeEnvironment.
- virtual NzaeAggregateMessageHandler& getMessageHandler() const =0
- Returns the message handler class object.
- Returns
- NzaeAggregateMessageHandler
- The instance of NzaeAggregateMessageHandler.
The message handler is where custom aggregate logic is implemented.
- virtual const NzaeParameters& getParameters() const =0
- Gets parameter information for the AE.
- Returns
- NzaeParameters
- The instance of NzaeParameters.
The message handler is where custom aggregate logic is implemented.
- virtual const NzaeRuntime& getRuntime() const =0
- Gets runtime information for the AE, including information about the Netezza software.
- Returns
- NzaeRuntime
- The instance of NzaeRuntime.
The message handler is where custom aggregate logic is implemented.
- virtual void log(LogLevel logLevel, const char *message) const =0
- Logs the specified message at the specified 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 log file name.
- virtual void ping() const =0
- Indicates that the AE is still active and not hanging.
- virtual void runAggregation(NzaeAggregateMessageHandler *messageHandler)=0
- Begins the Aggregation Message Processing.
- Parameters
- NzaeAggregateMessageHandler messageHandler
- The message handler.
Runs the aggregate using the message handler. The message handler is where custom aggreg-
ate logic is implemented.
- virtual NzaeAggType type() const =0
- Returns the type of the aggregate.
- Returns
- NzaeAggType
- The aggregate type.
- virtual void userError(const char *message) const =0
- Indicates that the AE has encountered an error condition.
- Parameters
- message
- The message to send back to the Netezza software.
Implies NzaeDone.
- virtual ~NzaeAggregate()