GenericArrayData (flink 1.11-SNAPSHOT API)

java.lang.Object
- org.apache.flink.table.data.GenericArrayData

All Implemented Interfaces:

ArrayData
```
@PublicEvolving
public final class GenericArrayData
extends Object
implements ArrayData
```
An internal data structure representing data of ArrayType.
GenericArrayData is a generic implementation of ArrayData which wraps regular Java arrays.
Note: All elements of this data structure must be internal data structures and must be of the same type. See RowData for more information about internal data structures.
For non-primitive arrays, elements can contain null for representing nullability.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.flink.table.data.ArrayData
  ArrayData.ElementGetter

Constructor Summary

Constructors
Constructor and Description
`GenericArrayData(boolean[] primitiveArray)`
`GenericArrayData(byte[] primitiveArray)`
`GenericArrayData(double[] primitiveArray)`
`GenericArrayData(float[] primitiveArray)`
`GenericArrayData(int[] primitiveArray)`
`GenericArrayData(long[] primitiveArray)`
`GenericArrayData(Object[] array)` Creates an instance of `GenericArrayData` using the given Java array.
`GenericArrayData(short[] primitiveArray)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`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.
`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.
`float`	`getFloat(int pos)` Returns the float value at the given position.
`int`	`getInt(int pos)` Returns the integer 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.
`<T> RawValueData<T>`	`getRawValue(int pos)` Returns the raw value at the given position.
`RowData`	`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.
`TimestampData`	`getTimestamp(int pos, int precision)` Returns the timestamp value at the given position.
`int`	`hashCode()`
`boolean`	`isNullAt(int pos)` Returns true if the element is null at the given position.
`boolean`	`isPrimitiveArray()` Returns true if this is a primitive array.
`int`	`size()` Returns the number of elements in this array.
`boolean[]`	`toBooleanArray()`
`byte[]`	`toByteArray()`
`double[]`	`toDoubleArray()`
`float[]`	`toFloatArray()`
`int[]`	`toIntArray()`
`long[]`	`toLongArray()`
`Object[]`	`toObjectArray()` Converts this `GenericArrayData` into an array of Java `Object`.
`short[]`	`toShortArray()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.table.data.ArrayData
createElementGetter, get

- Constructor Detail
  - GenericArrayData
```
public GenericArrayData(Object[] array)
```
    Creates an instance of GenericArrayData using the given Java array.
    Note: All elements of the array must be internal data structures.
  - GenericArrayData
```
public GenericArrayData(int[] primitiveArray)
```
  - GenericArrayData
```
public GenericArrayData(long[] primitiveArray)
```
  - GenericArrayData
```
public GenericArrayData(float[] primitiveArray)
```
  - GenericArrayData
```
public GenericArrayData(double[] primitiveArray)
```
  - GenericArrayData
```
public GenericArrayData(short[] primitiveArray)
```
  - GenericArrayData
```
public GenericArrayData(byte[] primitiveArray)
```
  - GenericArrayData
```
public GenericArrayData(boolean[] primitiveArray)
```
- Method Detail
  - isPrimitiveArray
```
public boolean isPrimitiveArray()
```
    Returns true if this is a primitive array.
    A primitive array is an array whose elements are of primitive type.
  - toObjectArray
```
public Object[] toObjectArray()
```
    Converts this GenericArrayData into an array of Java Object.
    The method will convert a primitive array into an object array. But it will not convert internal data structures into external data structures (e.g. StringData to String).
  - size
```
public int size()
```
    Description copied from interface: ArrayData
    
    Returns the number of elements in this array.
    
    Specified by:
    
    size in interface ArrayData
  - isNullAt
```
public boolean isNullAt(int pos)
```
    Description copied from interface: ArrayData
    
    Returns true if the element is null at the given position.
    
    Specified by:
    
    isNullAt in interface ArrayData
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getBoolean
```
public boolean getBoolean(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the boolean value at the given position.
    
    Specified by:
    
    getBoolean in interface ArrayData
  - getByte
```
public byte getByte(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the byte value at the given position.
    
    Specified by:
    
    getByte in interface ArrayData
  - getShort
```
public short getShort(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the short value at the given position.
    
    Specified by:
    
    getShort in interface ArrayData
  - getInt
```
public int getInt(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the integer value at the given position.
    
    Specified by:
    
    getInt in interface ArrayData
  - getLong
```
public long getLong(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the long value at the given position.
    
    Specified by:
    
    getLong in interface ArrayData
  - getFloat
```
public float getFloat(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the float value at the given position.
    
    Specified by:
    
    getFloat in interface ArrayData
  - getDouble
```
public double getDouble(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the double value at the given position.
    
    Specified by:
    
    getDouble in interface ArrayData
  - getBinary
```
public byte[] getBinary(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the binary value at the given position.
    
    Specified by:
    
    getBinary in interface ArrayData
  - getString
```
public StringData getString(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the string value at the given position.
    
    Specified by:
    
    getString in interface ArrayData
  - getDecimal
```
public DecimalData getDecimal(int pos,
                              int precision,
                              int scale)
```
    Description copied from interface: ArrayData
    
    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 ArrayData
  - getTimestamp
```
public TimestampData getTimestamp(int pos,
                                  int precision)
```
    Description copied from interface: ArrayData
    
    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 ArrayData
  - getRawValue
```
public <T> RawValueData<T> getRawValue(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the raw value at the given position.
    
    Specified by:
    
    getRawValue in interface ArrayData
  - getRow
```
public RowData getRow(int pos,
                      int numFields)
```
    Description copied from interface: ArrayData
    
    Returns the row value at the given position.
    The number of fields is required to correctly extract the row.
    
    Specified by:
    
    getRow in interface ArrayData
  - getArray
```
public ArrayData getArray(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the array value at the given position.
    
    Specified by:
    
    getArray in interface ArrayData
  - getMap
```
public MapData getMap(int pos)
```
    Description copied from interface: ArrayData
    
    Returns the map value at the given position.
    
    Specified by:
    
    getMap in interface ArrayData
  - toBooleanArray
```
public boolean[] toBooleanArray()
```
    Specified by:
    
    toBooleanArray in interface ArrayData
  - toByteArray
```
public byte[] toByteArray()
```
    Specified by:
    
    toByteArray in interface ArrayData
  - toShortArray
```
public short[] toShortArray()
```
    Specified by:
    
    toShortArray in interface ArrayData
  - toIntArray
```
public int[] toIntArray()
```
    Specified by:
    
    toIntArray in interface ArrayData
  - toLongArray
```
public long[] toLongArray()
```
    Specified by:
    
    toLongArray in interface ArrayData
  - toFloatArray
```
public float[] toFloatArray()
```
    Specified by:
    
    toFloatArray in interface ArrayData
  - toDoubleArray
```
public double[] toDoubleArray()
```
    Specified by:
    
    toDoubleArray in interface ArrayData

Back to Flink Website

Class GenericArrayData

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.data.ArrayData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.flink.table.data.ArrayData

Constructor Detail

GenericArrayData

GenericArrayData

GenericArrayData

GenericArrayData

GenericArrayData

GenericArrayData

GenericArrayData

GenericArrayData

Method Detail

isPrimitiveArray

toObjectArray

size

isNullAt

equals

hashCode

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getBinary

getString

getDecimal

getTimestamp

getRawValue

getRow

getArray

getMap

toBooleanArray

toByteArray

toShortArray

toIntArray

toLongArray

toFloatArray

toDoubleArray