NzaeMetadata Class reference

This class contains metadata about the AE, including input and output column attributes.

Column indexes are zero-based. See also: getMetadata, Datatypes.

Public member functions

int getCorrelationType()
Determines the correlation type used to invoke the UDTF.
int getInputColumnCount()
Gets the number of input columns.
int getInputNzType(int index)
Gets the input data type from NzaeDataTypes.
int getInputScale(int index)
The scale of the input column.
int getInputSize(int index)
Gets the size of the input column.
int getOutputColumnCount()
Gets the number of output columns.
int getOutputNzType(int index)
Gets the output data types from NzaeDataTypes .
int getOutputSize(int index)
Gets the size of the output column.
boolean hasFinal()
Determines if the UDTF is invoked with TABLE WITH FINAL.
boolean hasOrder()
Determines if the UDTF is invoked with ORDER BY in OVER.
boolean hasOver()
Determines if the UDTF is invoked with OVER.
boolean hasPartition()
Determines if the UDTF is invoked with PARTITION BY in OVER.
boolean inputIsConstant(int index)
Specifies if the value of the specified column is constant for all rows.
boolean isOneOutputRowRestriction()
Determines if the function is UDTF or UDF.
int outputScale(int index)
Gets the scale of the output column.

Static public attributes

NZAE_INNER_CORRELATION
Inner correlation table function correlation type.
NZAE_LEFT_CORRELATION
Left correlation table function correlation type.
NZAE_UNCORRELATED
Uncorrelated table function correlation type.
NZAE_UNKNOWN_CORRELATION_TYPE
Unknown table function correlation type.

Public member functions documentation

int getCorrelationType()
Determines the correlation type used to invoke the UDTF.
Returns

The correlation type.

int getInputColumnCount()
Gets the number of input columns.
Returns

The number of input columns.

int getInputNzType(int index)
Gets the input data type from NzaeDataTypes.
Parameters

  • index

    The input index.

Returns

The input data type.

int getInputScale(int index)
The scale of the input column.
Parameters

  • index

    The input index.

Returns

The scale of the input column.

int getInputSize(int index)
Gets the size of the input column.
Parameters

  • index

    The input index.

Returns

The length for string type, the precision for numeric type.

Length for string type, precision for numeric type.

int getOutputColumnCount()
Gets the number of output columns.
Returns

The number of output columns.

int getOutputNzType(int index)
Gets the output data types from NzaeDataTypes .
Parameters

  • index

    The input index.

Returns

The output data type.

int getOutputSize(int index)
Gets the size of the output column.
Parameters

  • index

    The input index.

Returns

The length for string type, the precision for numeric type.

Length for string type, precision for numeric type.

boolean hasFinal()
Determines if the UDTF is invoked with TABLE WITH FINAL.
Returns

TRUE if the table function is invoked using TABLE WITH FINAL.

boolean hasOrder()
Determines if the UDTF is invoked with ORDER BY in OVER.
Returns

TRUE if the table function is invoked using ORDER BY.

boolean hasOver()
Determines if the UDTF is invoked with OVER.
Returns

TRUE if the table function is invoked using OVER.

boolean hasPartition()
Determines if the UDTF is invoked with PARTITION BY in OVER.
Returns

TRUE if the table function is invoked using PARTITION BY.

boolean inputIsConstant(int index)
Specifies if the value of the specified column is constant for all rows.
Parameters

  • index

    The input index.

Returns

TRUE if the value of the column is constant for all rows.

If method returns TRUE then the value of this column is constant for all rows.

boolean isOneOutputRowRestriction()
Determines if the function is UDTF or UDF.
Returns

TRUE if the function is scalar; FALSE if the function is table.

Returns true if the function can only return one output row per input row.

int outputScale(int index)
Gets the scale of the output column.
Parameters

  • index

    The output index.

Returns

The scale of the output column.

Static member data documentation

final int NZAE_INNER_CORRELATION= 2
Inner correlation table function correlation type.
final int NZAE_LEFT_CORRELATION= 3
Left correlation table function correlation type.
final int NZAE_UNCORRELATED= 1
Uncorrelated table function correlation type.
final int NZAE_UNKNOWN_CORRELATION_TYPE= 0
Unknown table function correlation type.