GenericArray (Paimon : 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.data.GenericArray

All Implemented Interfaces:

Serializable, DataGetters, InternalArray
```
@Public
public final class GenericArray
extends Object
implements InternalArray, Serializable
```
An internal data structure representing data of ArrayType.
Note: All elements of this data structure must be internal data structures and must be of the same type. See InternalRow for more information about internal data structures.
GenericArray is a generic implementation of InternalArray which wraps regular Java arrays.

Since:

0.4.0

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.paimon.data.InternalArray
  InternalArray.ElementGetter

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`InternalArray`	`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.
`Decimal`	`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.
`InternalMap`	`getMap(int pos)` Returns the map value at the given position.
`InternalRow`	`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.
`BinaryString`	`getString(int pos)` Returns the string value at the given position.
`Timestamp`	`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 `GenericArray` 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.paimon.data.InternalArray
createElementGetter

- Constructor Detail
  - GenericArray
```
public GenericArray(Object[] array)
```
    Creates an instance of GenericArray using the given Java array.
    Note: All elements of the array must be internal data structures.
  - GenericArray
```
public GenericArray(int[] primitiveArray)
```
  - GenericArray
```
public GenericArray(long[] primitiveArray)
```
  - GenericArray
```
public GenericArray(float[] primitiveArray)
```
  - GenericArray
```
public GenericArray(double[] primitiveArray)
```
  - GenericArray
```
public GenericArray(short[] primitiveArray)
```
  - GenericArray
```
public GenericArray(byte[] primitiveArray)
```
  - GenericArray
```
public GenericArray(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 GenericArray 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. BinaryString to String).
  - size
```
public int size()
```
    Description copied from interface: InternalArray
    
    Returns the number of elements in this array.
    
    Specified by:
    
    size in interface InternalArray
  - isNullAt
```
public boolean isNullAt(int pos)
```
    Description copied from interface: DataGetters
    
    Returns true if the element is null at the given position.
    
    Specified by:
    
    isNullAt in interface DataGetters
  - 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: DataGetters
    
    Returns the boolean value at the given position.
    
    Specified by:
    
    getBoolean in interface DataGetters
  - getByte
```
public byte getByte(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the byte value at the given position.
    
    Specified by:
    
    getByte in interface DataGetters
  - getShort
```
public short getShort(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the short value at the given position.
    
    Specified by:
    
    getShort in interface DataGetters
  - getInt
```
public int getInt(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the integer value at the given position.
    
    Specified by:
    
    getInt in interface DataGetters
  - getLong
```
public long getLong(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the long value at the given position.
    
    Specified by:
    
    getLong in interface DataGetters
  - getFloat
```
public float getFloat(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the float value at the given position.
    
    Specified by:
    
    getFloat in interface DataGetters
  - getDouble
```
public double getDouble(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the double value at the given position.
    
    Specified by:
    
    getDouble in interface DataGetters
  - getBinary
```
public byte[] getBinary(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the binary value at the given position.
    
    Specified by:
    
    getBinary in interface DataGetters
  - getString
```
public BinaryString getString(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the string value at the given position.
    
    Specified by:
    
    getString in interface DataGetters
  - getDecimal
```
public Decimal getDecimal(int pos,
                          int precision,
                          int scale)
```
    Description copied from interface: DataGetters
    
    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 Decimal).
    
    Specified by:
    
    getDecimal in interface DataGetters
  - getTimestamp
```
public Timestamp getTimestamp(int pos,
                              int precision)
```
    Description copied from interface: DataGetters
    
    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 Timestamp).
    
    Specified by:
    
    getTimestamp in interface DataGetters
  - getRow
```
public InternalRow getRow(int pos,
                          int numFields)
```
    Description copied from interface: DataGetters
    
    Returns the row value at the given position.
    The number of fields is required to correctly extract the row.
    
    Specified by:
    
    getRow in interface DataGetters
  - getArray
```
public InternalArray getArray(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the array value at the given position.
    
    Specified by:
    
    getArray in interface DataGetters
  - getMap
```
public InternalMap getMap(int pos)
```
    Description copied from interface: DataGetters
    
    Returns the map value at the given position.
    
    Specified by:
    
    getMap in interface DataGetters
  - toBooleanArray
```
public boolean[] toBooleanArray()
```
    Specified by:
    
    toBooleanArray in interface InternalArray
  - toByteArray
```
public byte[] toByteArray()
```
    Specified by:
    
    toByteArray in interface InternalArray
  - toShortArray
```
public short[] toShortArray()
```
    Specified by:
    
    toShortArray in interface InternalArray
  - toIntArray
```
public int[] toIntArray()
```
    Specified by:
    
    toIntArray in interface InternalArray
  - toLongArray
```
public long[] toLongArray()
```
    Specified by:
    
    toLongArray in interface InternalArray
  - toFloatArray
```
public float[] toFloatArray()
```
    Specified by:
    
    toFloatArray in interface InternalArray
  - toDoubleArray
```
public double[] toDoubleArray()
```
    Specified by:
    
    toDoubleArray in interface InternalArray

Back to Paimon Website

Class GenericArray

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.paimon.data.InternalArray

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.paimon.data.InternalArray

Constructor Detail

GenericArray

GenericArray

GenericArray

GenericArray

GenericArray

GenericArray

GenericArray

GenericArray

Method Detail

isPrimitiveArray

toObjectArray

size

isNullAt

equals

hashCode

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getBinary

getString

getDecimal

getTimestamp

getRow

getArray

getMap

toBooleanArray

toByteArray

toShortArray

toIntArray

toLongArray

toFloatArray

toDoubleArray

Back to Paimon Website