Package org.apache.flink.cdc.common.data

Class GenericRecordData

java.lang.Object

org.apache.flink.cdc.common.data.GenericRecordData

All Implemented Interfaces:

RecordData

@PublicEvolving
public final class GenericRecordData
extends Object
implements RecordData

An internal data structure representing data of RecordData.

GenericRecordData is a generic implementation of RecordData which is backed by an array of Java Object. A GenericRecordData can have an arbitrary number of fields of different types. The fields in a row can be accessed by position (0-based) using either the generic getField(int) or type-specific getters (such as getInt(int)). A field can be updated by the generic setField(int, Object).

Note: All fields of this data structure must be internal data structures. See RecordData for more information about internal data structures.

The fields in GenericRecordData can be null for representing nullability.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.cdc.common.data.RecordData

RecordData.FieldGetter

Constructor Summary

Constructors

Constructor	Description
GenericRecordData(int arity)	Creates an instance of GenericRecordData with given number of fields.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getArity()	Returns the number of fields in this record.
ArrayData	getArray(int pos)	Returns the array value at the given position.
byte[]	getBinary(int pos)	Returns the binary value at the given position.
boolean	getBoolean(int pos)	Returns the boolean value at the given position.
byte	getByte(int pos)	Returns the byte value at the given position.
DateData	getDate(int pos)	Returns the Date data at the given position.
DecimalData	getDecimal(int pos, int precision, int scale)	Returns the decimal value at the given position.
double	getDouble(int pos)	Returns the double value at the given position.
Object	getField(int pos)	Returns the field value at the given position.
float	getFloat(int pos)	Returns the float value at the given position.
int	getInt(int pos)	Returns the integer value at the given position.
LocalZonedTimestampData	getLocalZonedTimestampData(int pos, int precision)	Returns the local zoned timestamp value at the given position.
long	getLong(int pos)	Returns the long value at the given position.
MapData	getMap(int pos)	Returns the map value at the given position.
RecordData	getRow(int pos, int numFields)	Returns the row value at the given position.
short	getShort(int pos)	Returns the short value at the given position.
StringData	getString(int pos)	Returns the string value at the given position.
TimeData	getTime(int pos)	Returns the Time data at the given position.
TimestampData	getTimestamp(int pos, int precision)	Returns the timestamp value at the given position.
Variant	getVariant(int pos)	Returns the variant value at the given position.
ZonedTimestampData	getZonedTimestamp(int pos, int precision)	Returns the zoned timestamp value at the given position.
int	hashCode()
boolean	isNullAt(int pos)	Returns true if the field is null at the given position.
static GenericRecordData	of(Object... values)	Creates an instance of GenericRecordData with given field values.
void	setField(int pos, Object value)	Sets the field value at the given position.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenericRecordData

public GenericRecordData(int arity)

Creates an instance of GenericRecordData with given number of fields.

Initially, all fields are set to null.

Note: All fields of the row must be internal data structures.

Parameters:

arity - number of fields

Method Detail

setField

public void setField(int pos,
                     Object value)

Sets the field value at the given position.

Note: The given field value must be an internal data structures. Otherwise the GenericRecordData is corrupted and may throw exception when processing. See RecordData for more information about internal data structures.

The field value can be null for representing nullability.

getField

public Object getField(int pos)

Returns the field value at the given position.

Note: The returned value is in internal data structure. See RecordData for more information about internal data structures.

The returned field value can be null for representing nullability.

getArity

public int getArity()

Description copied from interface: RecordData

Returns the number of fields in this record.

Specified by:

getArity in interface RecordData

isNullAt

public boolean isNullAt(int pos)

Description copied from interface: RecordData

Returns true if the field is null at the given position.

Specified by:

isNullAt in interface RecordData

getBoolean

public boolean getBoolean(int pos)

Description copied from interface: RecordData

Returns the boolean value at the given position.

Specified by:

getBoolean in interface RecordData

getByte

public byte getByte(int pos)

Description copied from interface: RecordData

Returns the byte value at the given position.

Specified by:

getByte in interface RecordData

getShort

public short getShort(int pos)

Description copied from interface: RecordData

Returns the short value at the given position.

Specified by:

getShort in interface RecordData

getInt

public int getInt(int pos)

Description copied from interface: RecordData

Returns the integer value at the given position.

Specified by:

getInt in interface RecordData

getLong

public long getLong(int pos)

Description copied from interface: RecordData

Returns the long value at the given position.

Specified by:

getLong in interface RecordData

getFloat

public float getFloat(int pos)

Description copied from interface: RecordData

Returns the float value at the given position.

Specified by:

getFloat in interface RecordData

getDouble

public double getDouble(int pos)

Description copied from interface: RecordData

Returns the double value at the given position.

Specified by:

getDouble in interface RecordData

getString

public StringData getString(int pos)

Description copied from interface: RecordData

Returns the string value at the given position.

Specified by:

getString in interface RecordData

getDecimal

public DecimalData getDecimal(int pos,
                              int precision,
                              int scale)

Description copied from interface: RecordData

Returns the decimal value at the given position.

The precision and scale are required to determine whether the decimal value was stored in a compact representation (see DecimalData).

Specified by:

getDecimal in interface RecordData

getTimestamp

public TimestampData getTimestamp(int pos,
                                  int precision)

Description copied from interface: RecordData

Returns the timestamp value at the given position.

The precision is required to determine whether the timestamp value was stored in a compact representation (see TimestampData).

Specified by:

getTimestamp in interface RecordData

getZonedTimestamp

public ZonedTimestampData getZonedTimestamp(int pos,
                                            int precision)

Description copied from interface: RecordData

Returns the zoned timestamp value at the given position.

The precision is required to determine whether the zoned timestamp value was stored in a compact representation (see ZonedTimestampData).

Specified by:

getZonedTimestamp in interface RecordData

getLocalZonedTimestampData

public LocalZonedTimestampData getLocalZonedTimestampData(int pos,
                                                          int precision)

Description copied from interface: RecordData

Returns the local zoned timestamp value at the given position.

The precision is required to determine whether the local zoned timestamp value was stored in a compact representation (see LocalZonedTimestampData).

Specified by:

getLocalZonedTimestampData in interface RecordData

getBinary

public byte[] getBinary(int pos)

Description copied from interface: RecordData

Returns the binary value at the given position.

Specified by:

getBinary in interface RecordData

getArray

public ArrayData getArray(int pos)

Description copied from interface: RecordData

Returns the array value at the given position.

Specified by:

getArray in interface RecordData

getMap

public MapData getMap(int pos)

Description copied from interface: RecordData

Returns the map value at the given position.

Specified by:

getMap in interface RecordData

getRow

public RecordData getRow(int pos,
                         int numFields)

Description copied from interface: RecordData

Returns the row value at the given position.

The number of fields is required to correctly extract the record.

Specified by:

getRow in interface RecordData

getDate

public DateData getDate(int pos)

Description copied from interface: RecordData

Returns the Date data at the given position.

Specified by:

getDate in interface RecordData

getTime

public TimeData getTime(int pos)

Description copied from interface: RecordData

Returns the Time data at the given position.

Specified by:

getTime in interface RecordData

getVariant

public Variant getVariant(int pos)

Description copied from interface: RecordData

Returns the variant value at the given position.

Specified by:

getVariant in interface RecordData

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static GenericRecordData of(Object... values)

Creates an instance of GenericRecordData with given field values.

Note: All fields of the row must be internal data structures.