VectorizedRowBatch (Hive Storage API 2.8.1 API)

java.lang.Object
- org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch

All Implemented Interfaces:

FilterContext, MutableFilterContext, org.apache.hadoop.io.Writable
```
public class VectorizedRowBatch
extends Object
implements org.apache.hadoop.io.Writable, MutableFilterContext
```
A VectorizedRowBatch is a set of rows, organized with each column as a vector. It is the unit of query execution, organized to minimize the cost per row and achieve high cycles-per-instruction. The major fields are public by design to allow fast and convenient access by the vectorized query execution code.

Field Summary

Fields
Modifier and Type	Field and Description
`ColumnVector[]`	`cols`
`static int`	`DEFAULT_BYTES`
`static int`	`DEFAULT_SIZE`
`boolean`	`endOfFile`
`int`	`numCols`
`int[]`	`projectedColumns`
`int`	`projectionSize`
`int[]`	`selected`
`boolean`	`selectedInUse`
`int`	`size`

Constructor Summary

Constructors
Constructor and Description
`VectorizedRowBatch(int numCols)` Return a batch with the specified number of columns.
`VectorizedRowBatch(int numCols, int size)` Return a batch with the specified number of columns and rows.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`count()` Return count of qualifying rows.
`void`	`ensureSize(int rows)` Set the maximum number of rows in the batch.
`int`	`getDataColumnCount()`
`int`	`getMaxSize()` Returns the maximum size of the batch (number of rows it can hold)
`int`	`getPartitionColumnCount()`
`int[]`	`getSelected()` Return an int array with the rows that pass the filter.
`int`	`getSelectedSize()` Return the number of rows that pass the filter.
`boolean`	`isSelectedInUse()` Is the filter applied?
`void`	`readFields(DataInput arg0)`
`void`	`reset()` Resets the row batch to default state - sets selectedInUse to false - sets size to 0 - sets endOfFile to false - resets each column - inits each column
`void`	`setFilterContext(boolean isSelectedInUse, int[] selected, int selectedSize)` Set context with the given values by reference.
`void`	`setPartitionInfo(int dataColumnCount, int partitionColumnCount)`
`void`	`setSelected(int[] selectedArray)` Set the array of the rows that pass the filter by reference.
`void`	`setSelectedInUse(boolean selectedInUse)` Set the selectedInUse boolean showing if the filter is applied.
`void`	`setSelectedSize(int selectedSize)` Set the number of the rows that pass the filter.
`String`	`stringify(String prefix)`
`String`	`stringifyColumn(int columnNum)`
`String`	`toString()`
`int[]`	`updateSelected(int minCapacity)` Get an array for selected that is expected to be modified.
`boolean`	`validateSelected()` Validate method checking if existing selected array contains accepted values.
`void`	`write(DataOutput arg0)`

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

Methods inherited from interface org.apache.hadoop.hive.ql.io.filter.MutableFilterContext
immutable

- Field Detail
  - numCols
```
public int numCols
```
  - cols
```
public ColumnVector[] cols
```
  - size
```
public int size
```
  - selected
```
public int[] selected
```
  - projectedColumns
```
public int[] projectedColumns
```
  - projectionSize
```
public int projectionSize
```
  - selectedInUse
```
public boolean selectedInUse
```
  - endOfFile
```
public boolean endOfFile
```
  - DEFAULT_SIZE
```
public static final int DEFAULT_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BYTES
```
public static final int DEFAULT_BYTES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VectorizedRowBatch
```
public VectorizedRowBatch(int numCols)
```
    Return a batch with the specified number of columns. This is the standard constructor -- all batches should be the same size
    
    Parameters:
    
    numCols - the number of columns to include in the batch
  - VectorizedRowBatch
```
public VectorizedRowBatch(int numCols,
                          int size)
```
    Return a batch with the specified number of columns and rows. Only call this constructor directly for testing purposes. Batch size should normally always be defaultSize.
    
    Parameters:
    
    numCols - the number of columns to include in the batch
    
    size - the number of rows to include in the batch
- Method Detail
  - setPartitionInfo
```
public void setPartitionInfo(int dataColumnCount,
                             int partitionColumnCount)
```
  - getDataColumnCount
```
public int getDataColumnCount()
```
  - getPartitionColumnCount
```
public int getPartitionColumnCount()
```
  - getMaxSize
```
public int getMaxSize()
```
    Returns the maximum size of the batch (number of rows it can hold)
  - count
```
public long count()
```
    Return count of qualifying rows.
    
    Returns:
    
    number of rows that have not been filtered out
  - stringifyColumn
```
public String stringifyColumn(int columnNum)
```
  - stringify
```
public String stringify(String prefix)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - readFields
```
public void readFields(DataInput arg0)
                throws IOException
```
    Specified by:
    
    readFields in interface org.apache.hadoop.io.Writable
    
    Throws:
    
    IOException
  - write
```
public void write(DataOutput arg0)
           throws IOException
```
    Specified by:
    
    write in interface org.apache.hadoop.io.Writable
    
    Throws:
    
    IOException
  - reset
```
public void reset()
```
    Resets the row batch to default state - sets selectedInUse to false - sets size to 0 - sets endOfFile to false - resets each column - inits each column
    
    Specified by:
    
    reset in interface FilterContext
  - ensureSize
```
public void ensureSize(int rows)
```
    Set the maximum number of rows in the batch. Data is not preserved.
  - isSelectedInUse
```
public boolean isSelectedInUse()
```
    Description copied from interface: FilterContext
    
    Is the filter applied?
    
    Specified by:
    
    isSelectedInUse in interface FilterContext
    
    Returns:
    
    true if the filter is actually applied
  - getSelected
```
public int[] getSelected()
```
    Description copied from interface: FilterContext
    
    Return an int array with the rows that pass the filter. Do not modify the array returned!
    
    Specified by:
    
    getSelected in interface FilterContext
    
    Returns:
    
    int array
  - getSelectedSize
```
public int getSelectedSize()
```
    Description copied from interface: FilterContext
    
    Return the number of rows that pass the filter.
    
    Specified by:
    
    getSelectedSize in interface FilterContext
    
    Returns:
    
    an int
  - setFilterContext
```
public void setFilterContext(boolean isSelectedInUse,
                             int[] selected,
                             int selectedSize)
```
    Description copied from interface: MutableFilterContext
    
    Set context with the given values by reference.
    
    Specified by:
    
    setFilterContext in interface MutableFilterContext
    
    Parameters:
    
    isSelectedInUse - if the filter is applied
    
    selected - an array of the selected rows
    
    selectedSize - the number of the selected rows
  - validateSelected
```
public boolean validateSelected()
```
    Description copied from interface: MutableFilterContext
    
    Validate method checking if existing selected array contains accepted values. Values should be in order and without duplicates i.e [1,1,1] is illegal
    
    Specified by:
    
    validateSelected in interface MutableFilterContext
    
    Returns:
    
    true if the selected array is valid
  - updateSelected
```
public int[] updateSelected(int minCapacity)
```
    Description copied from interface: MutableFilterContext
    
    Get an array for selected that is expected to be modified. If it is too small or unset, allocates one. This method never returns null!
    
    Specified by:
    
    updateSelected in interface MutableFilterContext
    
    Returns:
    
    the current selected array to be modified
  - setSelectedInUse
```
public void setSelectedInUse(boolean selectedInUse)
```
    Description copied from interface: MutableFilterContext
    
    Set the selectedInUse boolean showing if the filter is applied.
    
    Specified by:
    
    setSelectedInUse in interface MutableFilterContext
  - setSelected
```
public void setSelected(int[] selectedArray)
```
    Description copied from interface: MutableFilterContext
    
    Set the array of the rows that pass the filter by reference.
    
    Specified by:
    
    setSelected in interface MutableFilterContext
  - setSelectedSize
```
public void setSelectedSize(int selectedSize)
```
    Description copied from interface: MutableFilterContext
    
    Set the number of the rows that pass the filter.
    
    Specified by:
    
    setSelectedSize in interface MutableFilterContext

Class VectorizedRowBatch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hive.ql.io.filter.MutableFilterContext

Field Detail

numCols

cols

size

selected

projectedColumns

projectionSize

selectedInUse

endOfFile

DEFAULT_SIZE

DEFAULT_BYTES

Constructor Detail

VectorizedRowBatch

VectorizedRowBatch

Method Detail

setPartitionInfo

getDataColumnCount

getPartitionColumnCount

getMaxSize

count

stringifyColumn

stringify

toString

readFields

write

reset

ensureSize

isSelectedInUse

getSelected

getSelectedSize

setFilterContext

validateSelected

updateSelected

setSelectedInUse

setSelected

setSelectedSize