Public member functions documentation
- virtual void addOutputColumn(NzaeDataTypes::Types type, const char *columnName)=0
- Adds a non-string and non-numeric column.
- Parameters
- Types type
- The column type, which cannot be a string or numeric type.
- columnName
- The column name.
- virtual void addOutputColumnNumeric(NzaeDataTypes::Types type, const char *columnName, int
precision, int scale)=0
- Adds a numeric column.
- Parameters
- Types type
- The column type, which cannot be a string or numeric type.
- columnName
- The column name.
- precision
- The column precision.
- scale
- The column scale.
- virtual void addOutputColumnString(NzaeDataTypes::Types type, const char *columnName, int
size)=0
- Adds a string column.
- Parameters
- Types type
- The column type, which cannot be a string or numeric type.
- columnName
- The column name.
- size
- The column size.
- virtual bool catalogIsUpper() const =0
- Determines if the catalog is in upper case.
- Returns
- TRUE if catalog is upper case.
- virtual void close()=0
- Closes the AE and releases its resources.
- Releases all resources associated with he shaper.
- virtual const NzaeEnvironment& getEnvironment() const =0
- Gets the environment information for the AE.
- Returns
- NzaeEnvironment
- The instance of NzaeEnvironment.
- virtual const NzaeLibrary& getLibrary() const =0
- Gets library information about the AE.
- Returns
- NzaeLibrary
- The instance of NzaeLibrary.
- virtual NzaeShaperMessageHandler& getMessageHandler() const =0
- Returns the message handler class object.
- Returns
- NzaeShaperMessageHandler
- The instance of NzaeShaperMessageHandler.
- The message handler is where custom function logic is implemented.
- virtual const NzaeMetadata& getMetadata() const =0
- Gets metadata about the AE, including the input and output columns.
- Returns
- NzaeMetadata
- The instance of NzaeMetadata.
- virtual int getNumOutputColumns() const =0
- Gets number of output columns.
- Returns
- The number of output columns.
- virtual const NzaeShaperOutputColumnInfo& getOutputColumnInfo(int idx) const =0
- Gets output column information.
- Parameters
- idx
- The index of the column to get.
- Returns
- NzaeShaperOutputColumnInfo
- The column information.
- Exceptions
- NzaeException
- virtual const NzaeParameters& getParameters() const =0
- Gets parameter information for the AE.
- Returns
- NzaeParameters
- The instance of NzaeParameters .
- virtual const NzaeRuntime& getRuntime() const =0
- Gets runtime information for the AE, including information about the Netezza system.
- Returns
- NzaeRuntime
- The instance of NzaeRuntime.
- virtual const NzaeRecord& inputRow() const =0
- Gets the input row.
- Returns
- NzaeRecord
- The instance of NzaeRecord.
- 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 NzaeDataTypes::Types outputType() const =0
- Returns the UDF return type.
- Returns
- Types
- The return type.
- Gets the return type for a sizer (UDF). The value can only be one of the string types or
NUMERIC128.
- virtual void ping() const =0
- Indicates that the AE is still active and not hanging.
- virtual void run(NzaeShaperMessageHandler *messageHandler)=0
- Runs the shaper handler.
- Parameters
- NzaeShaperMessageHandler messageHandler
- The message handler. The message handler is where custom function logic is implemented.
- This function is an alternative to writing custom shaper code.
- virtual void update()=0
- Indicates that the shaper is done.
- 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 ~NzaeShaper()