NzaeShaper interface reference

This is the main Java AE Shaper API interface. Inherits NzaeBase

A reference to this interface can be obtained from static methods in the NzaeFactory class. See also: TestFactory.

Public member functions

void addOutputColumn(int type, String columnName): Adds an output column of a non-string or non-numeric type.
void addOutputColumnNumeric(int type, String columnName, int precision, int scale): Adds an output column of a numeric type.
void addOutputColumnString(int type, String columnName, int size): Adds an output column of a string type.
boolean catalogIsUpper(): Determines if the catalog is upper case.
void close(): Closes the AE and releases its resources.
int getApiType(): Returns the API Constant for this interface.
NzaeDataTypes getDataTypes(): Gets the NZ DataType constants.
NzaeEnvironment getEnvironment(): Gets environment information for the AE.
NzaeLibrary getLibrary(): Gets library information for the AE.
NzaeShaperMessageHandler getMessageHandler(): Returns the message handler class object.
NzaeMetadata getMetadata(): Gets metadata information for the AE.
int getNumOutputColumns(): Gets the number of output columns.
NzaeShaperOutputColumnInfo] getOutputColumnInfo(int idx): Gets information about the output columns.
NzaeRuntime getRuntime(): Gets runtime information for the AE, including information about the Netezza system.
NzaeRecord inputRow(): Gets the input row.
void log(int logLevel, String message): Log the specified message at the specified log level
int outputType(): Gets the return type for a sizer (UDF)
void ping(): Indicates that the AE is still active and not hanging.
void run(NzaeShaperMessageHandler messageHandler): Begins higher-level shaper processing.
int size(): Gets the output field size.
void update(): Signals that the shaper is done.
void userError(String message): Indicates the AE has encountered an error condition.

Static public attributes

LOG_DEBUG: Log level debug.
LOG_TRACE: Log level trace.

Public member functions documentation

void addOutputColumn(int type, String columnName)

Adds an output column of a non-string or non-numeric type.

Parameters

type: The column type; cannot be string or numeric.
columnName: The column name.

void addOutputColumnNumeric(int type, String columnName, int precision, int scale)

Adds an output column of a numeric type.

Parameters

type: The column type; must be numeric.
columnName: The column name.
precision: The column precision.
scale: The column scale.

void addOutputColumnString(int type, String columnName, int size)

Adds an output column of a string type.

Parameters

type: The column type; must be string.
columnName: The column name.
size: The column size.

boolean catalogIsUpper()

Determines if the catalog is upper case.

Returns

TRUE if the catalog is upper case.

void close()

Closes the AE and releases its resources.

int getApiType()

Returns the API Constant for this interface.

Returns

The values defined in NzaeApi .

NzaeDataTypes getDataTypes()

Gets the NZ DataType constants.

Returns

NzaeDataTypes: The data types object.

NzaeEnvironment getEnvironment()

Gets environment information for the AE.

Returns

NzaeEnvironment: The instance of NzaeEnvironment.

NzaeLibrary getLibrary()

Gets library information for the AE.

Returns

NzaeLibrary: The instance of NzaeLibrary.

NzaeShaperMessageHandler getMessageHandler()

Returns the message handler class object.

Returns

NzaeShaperMessageHandler: The instance of the Shaper handler.

NzaeMetadata getMetadata()

Gets metadata information for the AE.

Returns

NzaeMetadata: The instance of NzaeMetadata .

int getNumOutputColumns()

Gets the number of output columns.

Returns

The number of columns.

NzaeShaperOutputColumnInfo] getOutputColumnInfo(int idx)

Gets information about the output columns.

Parameters

idx: The index of the column to get.

Returns

NzaeShaperOutputColumnInfo: The column information.

NzaeRuntime getRuntime()

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

Returns

NzaeRuntime: The instance of NzaeRuntime.

NzaeRecord inputRow()

Gets the input row.

Returns

NzaeRecord: An instance of NzaeRecord.

void log(int logLevel, String message)

Log the specified message at the specified log level

Parameters

logLevel: The log level constant.
message: The message to log.

int outputType()

Gets the return type for a sizer (UDF)

Returns

The return type.

Must either be one of the string types or NUMERIC128

void ping()

Indicates that the AE is still active and not hanging.

void run(NzaeShaperMessageHandler messageHandler)

Begins higher-level shaper processing.

Parameters

NzaeShaperMessageHandler messageHandler: The message handler.
This is an alternative to writing custom shaper code.

int size()

Gets the output field size.

Returns

The output field size.

void update()

Signals that the shaper is done.

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.

Static member data documentation

final int LOG_DEBUG= 2: Log level debug.
final int LOG_TRACE= 1: Log level trace.