NzaeRecord Interface reference

A record corresponds to an input or output database row.

Each record consists of one or more fields, which correspond to columns. Fields are addresed by an int index which is zero-based. GetFieldX methods may return null. Objects applied to get and set methods must match or be convertable to or from the data type of the field (column).

See Also:
  • next
  • createOutputRecord
  • NzaeAggMessageHandler

Public member functions

boolean compatibleWithOutput()
Determines if the record can be used as an output result.
NzaeRecord duplicate()
Creates a deep copy duplicate.
Object getField(int index)
Returns the field value as an Object.
byte [] getFieldAsBinary(int index)
Returns the field value cast to a byte [], that is a byte array.
Boolean getFieldAsBoolean(int index)
Returns the field value cast to a Boolean.
java.sql.Date getFieldAsDate(int index)
Returns the field value cast to a java.sql.Date.
BigDecimal getFieldAsDecimal(int index)
Returns the field value cast to a BigDecimal.
NzaeInterval getFieldAsInterval(int index)
Returns the field value cast to a NzaeInterval .
Number getFieldAsNumber(int index)
Returns the field value cast to a Number.
String getFieldAsString(int index)
Returns the field value cast to a String.
java.sql.Time getFieldAsTime(int index)
Returns the field value cast to a java.sql.Time.
java.sql.Timestamp getFieldAsTimestamp(int index)
Returns the field value cast to a java.sql.Timestamp.
NzaeTimeTz getFieldAsTimeTz(int index)
Returns the field value cast to a NzaeTimeTz .
NzaeFieldInfo getFieldInfo(int index)
Returns instance of NzaeFieldInfo interface.
boolean isReadOnly()
Determines if the record is read-only.
void setField(int index, Object value)
Sets the field value as an Object.
void setFields(NzaeRecord rec)
Sets all the fields from a record consisting of the same number and type of fields.
int size()
Gets the number of fields.
String toString()
The string representation of the record.

Public member functions documentation

boolean compatibleWithOutput()
Determines if the record can be used as an output result.
Returns

TRUE if it can be used as an output result.

Can be an output for a function, or a state or final result record for an aggregate.

NzaeRecord duplicate()
Creates a deep copy duplicate.
Returns

NzaeRecord

The duplicate record.

The duplicate cannot be read-only.

Object getField(int index)
Returns the field value as an Object.
Parameters
index

The field index.

Returns

The field as an Object.

byte [] getFieldAsBinary(int index)
Returns the field value cast to a byte [], that is a byte array.
Parameters
index

The field index.

Returns

The field as an byte array.

The field must have already been set to use a binary interpretation using Nzae setInter- pretCharAsBinary or NzaeAgg setInputInterpretCharAsBinary / setStateInterpretCharAsBinary.

See also: setInterpretCharAsBinary, setInputInterpretCharAsBinary,setStateInterpretCharAsBinary.
Boolean getFieldAsBoolean(int index)
Returns the field value cast to a Boolean.
Parameters
index

The field index.

Returns

The field as a Boolean.

java.sql.Date getFieldAsDate(int index)
Returns the field value cast to a java.sql.Date.
Parameters
index

The field index.

Returns

The field as a java.sql.Date.

BigDecimal getFieldAsDecimal(int index)
Returns the field value cast to a BigDecimal.
Parameters
index

The field index.

Returns

The field as a BigDecimal.

NzaeInterval getFieldAsInterval(int index)
Returns the field value cast to a NzaeInterval .
Parameters
index

The field index.

Returns

NzaeInterval

The field as an NzaeInterval .

Number getFieldAsNumber(int index)
Returns the field value cast to a Number.
Parameters
index

The field index.

Returns

The field as a Number.

String getFieldAsString(int index)
Returns the field value cast to a String.
Parameters
index

The field index.

Returns

The field as a String.

java.sql.Time getFieldAsTime(int index)
Returns the field value cast to a java.sql.Time.
Parameters
index

The field index.

Returns

The field as a java.sql.Time.

java.sql.Timestamp getFieldAsTimestamp(int index)
Returns the field value cast to a java.sql.Timestamp.
Parameters
index

The field index.

Returns

The field as a java.sql.Timestamp.

NzaeTimeTz getFieldAsTimeTz(int index)
Returns the field value cast to a NzaeTimeTz .
Parameters
index

The field index.

Returns

NzaeTimeTz

The field as an NzaeTimeTz .

NzaeFieldInfo getFieldInfo(int index)
Returns instance of NzaeFieldInfo interface.
Parameters
index

The field index.

Returns

NzaeFieldInfo

The FieldInfo object.

boolean isReadOnly()
Determines if the record is read-only.
Returns

TRUE if the record is read-only.

void setField(int index, Object value)
Sets the field value as an Object.
Parameters
index

The field index.

value

The field value.

NULL is a valid value.

void setFields(NzaeRecord rec)
Sets all the fields from a record consisting of the same number and type of fields.
Parameters
NzaeRecord rec

Record.

int size()
Gets the number of fields.
Returns

The number of fields.

String toString()
The string representation of the record.
Returns

The string representation.