Module org.apache.arrow.vector
Package org.apache.arrow.vector.table

Class Row

java.lang.Object
org.apache.arrow.vector.table.Row
All Implemented Interfaces:
Iterator<Row>
public class Row extends Object implements Iterator<Row>
Row is a positionable, immutable cursor backed by a Table.

Getters are provided for most vector types. The exceptions being NullVector, which only contains null values and has no getter, and ZeroVector, which is a zero-length vector of any type

This API is EXPERIMENTAL.

  • Field Details

    • table

      protected final BaseTable table
      The table we're enumerating.

    • rowNumber

      protected int rowNumber
      the current row number.

  • Constructor Details

    • Row

      public Row(BaseTable table)
      Constructs a new Row backed by the given table.
      Parameters:
      table - the table that this Row object represents

  • Method Details

    • resetPosition

      public Row resetPosition()
      Resets the current row to -1 and returns this object.

    • setPosition

      public Row setPosition(int rowNumber)
      Moves this Row to the given 0-based row index.
      Returns:
      this Row for chaining

    • isNull

      public boolean isNull(String columnName)
      For vectors other than Union and DenseUnion, returns true if the value at columnName is null, and false otherwise.

      UnionVector#isNull always returns false, but the underlying vector may hold null values.

    • isNull

      public boolean isNull(int columnIndex)
      For vectors other than Union and DenseUnion, returns true if the value at columnIndex is null, and false otherwise.

      UnionVector#isNull always returns false, but the underlying vector may hold null values.

    • getExtensionType

      public Object getExtensionType(int vectorIndex)
      Returns an object representing the value in the ExtensionTypeVector at the currentRow and vectorIndex. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if the type is incorrect.

    • getExtensionType

      public Object getExtensionType(String columnName)
      Returns an object representing the value in the named ExtensionTypeVector at the currentRow. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type.
      Parameters:
      columnName - The name of the vector providing the result
      Returns:
      The object in the named column at the current row

    • getMap

      public List<?> getMap(int vectorIndex)
      Returns a Map from the column of the given vectorIndex at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type.

    • getMap

      public List<?> getMap(String columnName)
      Returns a Map from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getStruct

      public Object getStruct(int vectorIndex)
      Returns an Object from the column at vectorIndex at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getStruct

      public Object getStruct(String columnName)
      Returns an Object from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getUnion

      public Object getUnion(int vectorIndex)
      Returns an Object from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getUnion

      public Object getUnion(String columnName)
      Returns an Object from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getDenseUnion

      public Object getDenseUnion(String columnName)
      Returns an Object from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getDenseUnion

      public Object getDenseUnion(int vectorIndex)
      Returns an Object from the column with the given vectorIndex at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getList

      public List<?> getList(String columnName)
      Returns a List from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getList

      public List<?> getList(int columnIndex)
      Returns a List from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present and a ClassCastException is thrown if it has a different type

    • getInt

      public int getInt(String columnName)
      Returns an int from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getInt

      public int getInt(int columnIndex)
      Returns an int from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present and a ClassCastException is thrown if it has a different type

    • getInt

      public void getInt(String columnName, NullableIntHolder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getInt

      public void getInt(int columnIndex, NullableIntHolder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present and a ClassCastException is thrown if it has a different type

    • getUInt4

      public int getUInt4(String columnName)
      Returns an int from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getUInt4

      public int getUInt4(int columnIndex)
      Returns an int from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present and a ClassCastException is thrown if it has a different type

    • getUInt4

      public void getUInt4(String columnName, NullableUInt4Holder holder)
      Updates the holder with the value at the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getUInt4

      public void getUInt4(int columnIndex, NullableUInt4Holder holder)
      Updates the holder with the value at the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present and a ClassCastException is thrown if it has a different type

    • getSmallInt

      public short getSmallInt(String columnName)
      Returns a short from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getSmallInt

      public short getSmallInt(int columnIndex)
      Returns a short from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getSmallInt

      public void getSmallInt(String columnName, NullableSmallIntHolder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getSmallInt

      public void getSmallInt(int columnIndex, NullableSmallIntHolder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt2

      public char getUInt2(String columnName)
      Returns a char from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt2

      public char getUInt2(int columnIndex)
      Returns a char from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt2

      public void getUInt2(String columnName, NullableUInt2Holder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt2

      public void getUInt2(int columnIndex, NullableUInt2Holder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTinyInt

      public byte getTinyInt(String columnName)
      Returns a byte from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTinyInt

      public byte getTinyInt(int columnIndex)
      Returns a byte from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTinyInt

      public void getTinyInt(String columnName, NullableTinyIntHolder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTinyInt

      public void getTinyInt(int columnIndex, NullableTinyIntHolder holder)
      Updates the holder with the value in the column at the given index and current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt1

      public byte getUInt1(String columnName)
      Returns a byte from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt1

      public byte getUInt1(int columnIndex)
      Returns a byte from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt1

      public void getUInt1(String columnName, NullableUInt1Holder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt1

      public void getUInt1(int columnIndex, NullableUInt1Holder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getBigInt

      public long getBigInt(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getBigInt

      public long getBigInt(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getBigInt

      public void getBigInt(String columnName, NullableBigIntHolder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getBigInt

      public void getBigInt(int columnIndex, NullableBigIntHolder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt8

      public long getUInt8(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt8

      public long getUInt8(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt8

      public void getUInt8(String columnName, NullableUInt8Holder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getUInt8

      public void getUInt8(int columnIndex, NullableUInt8Holder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFloat4

      public float getFloat4(String columnName)
      Returns a float from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFloat4

      public float getFloat4(int columnIndex)
      Returns a float from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFloat4

      public void getFloat4(String columnName, NullableFloat4Holder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFloat4

      public void getFloat4(int columnIndex, NullableFloat4Holder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFloat8

      public double getFloat8(String columnName)
      Returns a double from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFloat8

      public double getFloat8(int columnIndex)
      Returns a double from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFloat8

      public void getFloat8(String columnName, NullableFloat8Holder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFloat8

      public void getFloat8(int columnIndex, NullableFloat8Holder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getBit

      public int getBit(String columnName)
      Returns an int from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getBit

      public int getBit(int columnIndex)
      Returns an int from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getBit

      public void getBit(String columnName, NullableBitHolder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getBit

      public void getBit(int columnIndex, NullableBitHolder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDateMilli

      public long getDateMilli(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getDateMilli

      public long getDateMilli(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getDateMilli

      public void getDateMilli(String columnName, NullableDateMilliHolder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDateMilli

      public void getDateMilli(int columnIndex, NullableDateMilliHolder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDateDay

      public int getDateDay(String columnName)
      Returns an int from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getDateDay

      public int getDateDay(int columnIndex)
      Returns an int from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getDateDay

      public void getDateDay(String columnName, NullableDateDayHolder holder)
      Updates the holder with the value in the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDateDay

      public void getDateDay(int columnIndex, NullableDateDayHolder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeNano

      public long getTimeNano(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeNano

      public long getTimeNano(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeNano

      public void getTimeNano(String columnName, NullableTimeNanoHolder holder)
      Updates the holder with the value in the column with the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeNano

      public void getTimeNano(int columnIndex, NullableTimeNanoHolder holder)
      Updates the holder with the value in the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMicro

      public long getTimeMicro(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMicro

      public long getTimeMicro(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMicro

      public void getTimeMicro(String columnName, NullableTimeMicroHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMicro

      public void getTimeMicro(int columnIndex, NullableTimeMicroHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMilli

      public int getTimeMilli(String columnName)
      Returns an int from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMilli

      public int getTimeMilli(int columnIndex)
      Returns an int from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMilli

      public void getTimeMilli(String columnName, NullableTimeMilliHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMilli

      public void getTimeMilli(int columnIndex, NullableTimeMilliHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMilliObj

      public LocalDateTime getTimeMilliObj(String columnName)
      Returns a LocalDateTime from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeMilliObj

      public LocalDateTime getTimeMilliObj(int columnIndex)
      Returns a LocalDateTime from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeSec

      public int getTimeSec(String columnName)
      Returns an int from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeSec

      public int getTimeSec(int columnIndex)
      Returns an int from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeSec

      public void getTimeSec(String columnName, NullableTimeSecHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeSec

      public void getTimeSec(int columnIndex, NullableTimeSecHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeStampSec

      public long getTimeStampSec(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type.

    • getTimeStampSec

      public long getTimeStampSec(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampSec

      public void getTimeStampSec(String columnName, NullableTimeStampSecHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampSec

      public void getTimeStampSec(int columnIndex, NullableTimeStampSecHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampSecObj

      public LocalDateTime getTimeStampSecObj(String columnName)
      Returns a LocalDateTime from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampSecObj

      public LocalDateTime getTimeStampSecObj(int columnIndex)
      Returns a LocalDateTime from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampSecTZ

      public long getTimeStampSecTZ(String columnName)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampSecTZ

      public long getTimeStampSecTZ(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampSecTZ

      public void getTimeStampSecTZ(String columnName, NullableTimeStampSecTZHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampSecTZ

      public void getTimeStampSecTZ(int columnIndex, NullableTimeStampSecTZHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNano

      public long getTimeStampNano(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNano

      public long getTimeStampNano(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNano

      public void getTimeStampNano(String columnName, NullableTimeStampNanoHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNano

      public void getTimeStampNano(int columnIndex, NullableTimeStampNanoHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNanoObj

      public LocalDateTime getTimeStampNanoObj(String columnName)
      Returns a LocalDateTime from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNanoObj

      public LocalDateTime getTimeStampNanoObj(int columnIndex)
      Returns a LocalDateTime from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNanoTZ

      public long getTimeStampNanoTZ(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNanoTZ

      public long getTimeStampNanoTZ(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNanoTZ

      public void getTimeStampNanoTZ(String columnName, NullableTimeStampNanoTZHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampNanoTZ

      public void getTimeStampNanoTZ(int columnIndex, NullableTimeStampNanoTZHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilli

      public long getTimeStampMilli(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilli

      public long getTimeStampMilli(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilli

      public void getTimeStampMilli(String columnName, NullableTimeStampMilliHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilli

      public void getTimeStampMilli(int columnIndex, NullableTimeStampMilliHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilliObj

      public LocalDateTime getTimeStampMilliObj(String columnName)
      Returns a LocalDateTime from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilliObj

      public LocalDateTime getTimeStampMilliObj(int columnIndex)
      Returns a LocalDateTime from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilliTZ

      public long getTimeStampMilliTZ(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilliTZ

      public long getTimeStampMilliTZ(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMilliTZ

      public void getTimeStampMilliTZ(String columnName, NullableTimeStampMilliTZHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different types

    • getTimeStampMilliTZ

      public void getTimeStampMilliTZ(int columnIndex, NullableTimeStampMilliTZHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicro

      public long getTimeStampMicro(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicro

      public long getTimeStampMicro(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicro

      public void getTimeStampMicro(String columnName, NullableTimeStampMicroHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicro

      public void getTimeStampMicro(int columnIndex, NullableTimeStampMicroHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicroObj

      public LocalDateTime getTimeStampMicroObj(String columnName)
      Returns a LocalDateTime from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicroObj

      public LocalDateTime getTimeStampMicroObj(int columnIndex)
      Returns a LocalDateTime from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicroTZ

      public long getTimeStampMicroTZ(String columnName)
      Returns a long from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicroTZ

      public long getTimeStampMicroTZ(int columnIndex)
      Returns a long from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicroTZ

      public void getTimeStampMicroTZ(String columnName, NullableTimeStampMicroTZHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getTimeStampMicroTZ

      public void getTimeStampMicroTZ(int columnIndex, NullableTimeStampMicroTZHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDurationObj

      public Duration getDurationObj(String columnName)
      Returns a Duration from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDurationObj

      public Duration getDurationObj(int columnIndex)
      Returns a Duration from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDuration

      public ArrowBuf getDuration(String columnName)
      Returns an ArrowBuf from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDuration

      public ArrowBuf getDuration(int columnIndex)
      Returns an ArrowBuf from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDuration

      public void getDuration(String columnName, NullableDurationHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDuration

      public void getDuration(int columnIndex, NullableDurationHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalMonthDayNanoObj

      public PeriodDuration getIntervalMonthDayNanoObj(String columnName)
      Returns a PeriodDuration from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalMonthDayNanoObj

      public PeriodDuration getIntervalMonthDayNanoObj(int columnIndex)
      Returns a PeriodDuration from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalMonthDayNano

      public ArrowBuf getIntervalMonthDayNano(String columnName)
      Returns an ArrowBuf from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalMonthDayNano

      public ArrowBuf getIntervalMonthDayNano(int columnIndex)
      Returns an ArrowBuf from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalMonthDayNano

      public void getIntervalMonthDayNano(String columnName, NullableIntervalMonthDayNanoHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalMonthDayNano

      public void getIntervalMonthDayNano(int columnIndex, NullableIntervalMonthDayNanoHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalDay

      public ArrowBuf getIntervalDay(String columnName)
      Returns an ArrowBuf from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalDay

      public ArrowBuf getIntervalDay(int columnIndex)
      Returns an ArrowBuf from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalDay

      public void getIntervalDay(String columnName, NullableIntervalDayHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalDay

      public void getIntervalDay(int columnIndex, NullableIntervalDayHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalDayObj

      public Duration getIntervalDayObj(int columnIndex)
      Returns a Duration from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalDayObj

      public Duration getIntervalDayObj(String columnName)
      Returns a Duration from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getIntervalYearObj

      public Period getIntervalYearObj(String columnName)
      Returns a Period from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type
      Returns:
      a Period of n MONTHS, not YEARS

    • getIntervalYearObj

      public Period getIntervalYearObj(int columnIndex)
      Returns a Period from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type
      Returns:
      a Period of n MONTHS, not YEARS

    • getIntervalYear

      public int getIntervalYear(String columnName)
      Returns an int from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type
      Returns:
      the number of MONTHS in the interval (not YEARS)

    • getIntervalYear

      public int getIntervalYear(int columnIndex)
      Returns an int from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type
      Returns:
      the number of MONTHS in the interval (not YEARS)

    • getIntervalYear

      public void getIntervalYear(String columnName, NullableIntervalYearHolder holder)
      Updates the holder with the value from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type
      Parameters:
      holder - a holder to store the interval. Note that the value of the holder represents MONTHS not years

    • getIntervalYear

      public void getIntervalYear(int columnIndex, NullableIntervalYearHolder holder)
      Updates the holder with the value from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type
      Parameters:
      holder - a holder to store the interval. Note that the value of the holder represents MONTHS not years

    • getDecimal

      public void getDecimal(int columnIndex, NullableDecimalHolder holder)
      Updates the value of the holder with data from vector at the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDecimal

      public void getDecimal(String columnName, NullableDecimalHolder holder)
      Updates the value of the holder with data from the vector with given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDecimalObj

      public BigDecimal getDecimalObj(String columnName)
      Returns a BigDecimal from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDecimalObj

      public BigDecimal getDecimalObj(int columnIndex)
      Returns a BigDecimal from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDecimal

      public ArrowBuf getDecimal(String columnName)
      Returns an ArrowBuf from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getDecimal

      public ArrowBuf getDecimal(int columnIndex)
      Returns an ArrowBuf from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getVarBinary

      public byte[] getVarBinary(String columnName)
      Returns a byte[] from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getVarBinary

      public byte[] getVarBinary(int columnIndex)
      Returns a byte[] from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFixedSizeBinary

      public byte[] getFixedSizeBinary(String columnName)
      Returns a byte[] from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getFixedSizeBinary

      public byte[] getFixedSizeBinary(int columnIndex)
      Returns a byte[] from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getLargeVarBinary

      public byte[] getLargeVarBinary(String columnName)
      Returns a byte[] from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getLargeVarBinary

      public byte[] getLargeVarBinary(int columnIndex)
      Returns a byte[] from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present, and a ClassCastException is thrown if it is present but has a different type

    • getVarCharObj

      public String getVarCharObj(String columnName)
      Returns a String from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

      StandardCharsets.UTF_8 is used as the charset

    • getVarCharObj

      public String getVarCharObj(int columnIndex)
      Returns a String from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type
      Parameters:
      columnIndex - the index of the FieldVector holding the value

    • getVarChar

      public byte[] getVarChar(String columnName)
      Returns a byte[] from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

      StandardCharsets.UTF_8 is used as the charset

    • getVarChar

      public byte[] getVarChar(int columnIndex)
      Returns a byte[] from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type
      Parameters:
      columnIndex - the index of the FieldVector holding the value

    • getLargeVarCharObj

      public String getLargeVarCharObj(String columnName)
      Returns a String from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

      StandardCharsets.UTF_8 is used as the charset, unless this cursor was created with a default Charset

    • getLargeVarCharObj

      public String getLargeVarCharObj(int columnIndex)
      Returns a String from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • getLargeVarChar

      public byte[] getLargeVarChar(String columnName)
      Returns a byte[] from the column of the given name at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

      StandardCharsets.UTF_8 is used as the charset, unless this cursor was created with a default Charset

    • getLargeVarChar

      public byte[] getLargeVarChar(int columnIndex)
      Returns a byte[] from the column with the given index at the current row. An IllegalArgumentException is thrown if the column is not present in the Row and a ClassCastException is thrown if it has a different type

    • hasNext

      public boolean hasNext()
      Returns true if there is at least one more non-deleted row in the table that has yet to be processed.
      Specified by:
      hasNext in interface Iterator<Row>

    • next

      public Row next()
      Returns the next non-deleted row in the table.
      Specified by:
      next in interface Iterator<Row>
      Throws:
      NoSuchElementException - if there are no more rows

    • getRowNumber

      public int getRowNumber()

    • getDefaultCharacterSet

      public Charset getDefaultCharacterSet()
      Returns the default character set for use with character vectors.