BatchData (TsFile 0.14.0-preview1 API)

java.lang.Object
- org.apache.iotdb.tsfile.read.common.BatchData

Direct Known Subclasses:

DescReadBatchData, ExceptionBatchData, SignalBatchData
```
public class BatchData
extends Object
```
BatchData is a self-defined data structure which is optimized for different type of values. This class can be viewed as a collection which is more efficient than ArrayList.
This class records a time list and a value list, which could be replaced by TVList in the future
When you use BatchData in query process, it does not contain duplicated timestamps. The batch data may be empty.
If you get a batch data, you can iterate the data as the following codes:
while (batchData.hasCurrent()) { long time = batchData.currentTime(); Object value = batchData.currentValue(); batchData.next(); }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BatchData.BatchDataType

Nested Classes
Modifier and Type	Class and Description
`static class`	`BatchData.BatchDataType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected BatchData.BatchDataType`	`batchDataType`
`protected List<Binary[]>`	`binaryRet`
`protected List<boolean[]>`	`booleanRet`
`protected int`	`capacity`
`protected static int`	`CAPACITY_THRESHOLD`
`protected int`	`count`
`protected TSDataType`	`dataType`
`protected List<double[]>`	`doubleRet`
`protected List<float[]>`	`floatRet`
`protected List<int[]>`	`intRet`
`protected List<long[]>`	`longRet`
`protected int`	`readCurArrayIndex`
`protected int`	`readCurListIndex`
`protected List<long[]>`	`timeRet`
`protected List<TsPrimitiveType[][]>`	`vectorRet`
`protected int`	`writeCurArrayIndex`
`protected int`	`writeCurListIndex`

Constructor Summary

Constructors
Constructor and Description

BatchData()

BatchData(TSDataType type)
BatchData Constructor.

Constructors
Constructor and Description
`BatchData()`
`BatchData(TSDataType type)` BatchData Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`currentTime()`
`TsPrimitiveType`	`currentTsPrimitiveType()`
`Object`	`currentValue()` get current value.
`BatchData`	`flip()` When put data, the writeIndex increases while the readIndex remains 0.
`org.apache.iotdb.tsfile.read.common.BatchData.BatchDataIterator`	`getBatchDataIterator()`
`IBatchDataIterator`	`getBatchDataIterator(int subIndex)` Only used for the batch data of vector time series.
`BatchData.BatchDataType`	`getBatchDataType()`
`Binary`	`getBinary()`
`Binary`	`getBinaryByIndex(int idx)` Get the idx th binary value by the time ascending order
`boolean`	`getBoolean()`
`boolean`	`getBooleanByIndex(int idx)` Get the idx th boolean value by the time ascending order
`TSDataType`	`getDataType()`
`double`	`getDouble()`
`double`	`getDoubleByIndex(int idx)` Get the idx th double value by the time ascending order
`float`	`getFloat()`
`float`	`getFloatByIndex(int idx)` Get the idx th float value by the time ascending order
`int`	`getInt()`
`int`	`getIntByIndex(int idx)` Get the idx th int value by the time ascending order
`TimeValuePair`	`getLastPairBeforeOrEqualTimestamp(long queryTime)`
`long`	`getLong()`
`long`	`getLongByIndex(int idx)` Get the idx th long value by the time ascending order
`long`	`getMaxTimestamp()`
`long`	`getMinTimestamp()`
`int`	`getReadCurArrayIndex()`
`int`	`getReadCurListIndex()`
`long`	`getTimeByIndex(int idx)` Get the idx th timestamp by the time ascending order
`Object`	`getValueInTimestamp(long time)`
`TsPrimitiveType[]`	`getVector()`
`TsPrimitiveType[]`	`getVectorByIndex(int idx)` Get the idx th vector value by the time ascending order
`boolean`	`hasCurrent()`
`void`	`init(TSDataType type)` initialize batch data.
`boolean`	`isEmpty()`
`int`	`length()`
`void`	`next()`
`void`	`putAnObject(long t, Object v)` put an object.
`void`	`putBinary(long t, Binary v)` put binary data.
`void`	`putBoolean(long t, boolean v)` put boolean data.
`void`	`putDouble(long t, double v)` put double data.
`void`	`putFloat(long t, float v)` put float data.
`void`	`putInt(long t, int v)` put int data.
`void`	`putLong(long t, long v)` put long data.
`void`	`putVector(long t, TsPrimitiveType[] v)` put vector data.
`void`	`resetBatchData()` This method is used to reset batch data when more than one group by aggregation functions visit the same batch data
`void`	`resetBatchData(int readCurArrayIndex, int readCurListIndex)`
`void`	`serializeData(DataOutputStream outputStream)` For any implementation of BatchData, the data serializing sequence must equal the one of writing, otherwise after deserializing the sequence will be reversed
`void`	`setBinary(Binary v)`
`void`	`setBoolean(boolean v)`
`void`	`setDataType(TSDataType dataType)`
`void`	`setDouble(double v)`
`void`	`setFloat(float v)`
`void`	`setInt(int v)`
`void`	`setLong(long v)`
`void`	`setTime(long v)`
`void`	`setVector(TsPrimitiveType[] v)`

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

Field Detail

CAPACITY_THRESHOLD
```
protected static final int CAPACITY_THRESHOLD
```
See Also:

Constant Field Values

capacity
```
protected int capacity
```

dataType
```
protected TSDataType dataType
```

batchDataType

protected BatchData.BatchDataType batchDataType

readCurListIndex
```
protected int readCurListIndex
```

readCurArrayIndex
```
protected int readCurArrayIndex
```

writeCurListIndex
```
protected int writeCurListIndex
```

writeCurArrayIndex
```
protected int writeCurArrayIndex
```

count
```
protected int count
```

timeRet
```
protected List<long[]> timeRet
```

booleanRet
```
protected List<boolean[]> booleanRet
```

intRet
```
protected List<int[]> intRet
```

longRet
```
protected List<long[]> longRet
```

floatRet
```
protected List<float[]> floatRet
```

doubleRet
```
protected List<double[]> doubleRet
```

binaryRet
```
protected List<Binary[]> binaryRet
```

vectorRet

protected List<TsPrimitiveType[][]> vectorRet

Constructor Detail
- BatchData
```
public BatchData()
```
- BatchData
```
public BatchData(TSDataType type)
```
  BatchData Constructor.
  
  Parameters:
  
  type - Data type to record for this BatchData

Method Detail

isEmpty
```
public boolean isEmpty()
```

hasCurrent
```
public boolean hasCurrent()
```

next
```
public void next()
```

currentTime
```
public long currentTime()
```

currentValue
```
public Object currentValue()
```
get current value.

Returns:

current value

currentTsPrimitiveType

public TsPrimitiveType currentTsPrimitiveType()

getDataType
```
public TSDataType getDataType()
```

setDataType

public void setDataType(TSDataType dataType)

getBatchDataType

public BatchData.BatchDataType getBatchDataType()

init
```
public void init(TSDataType type)
```
initialize batch data.

Parameters:

type - TSDataType

putBoolean

public void putBoolean(long t,
                       boolean v)

put boolean data.

Parameters:: t - timestamp; v - boolean data

putInt

public void putInt(long t,
                   int v)

put int data.

Parameters:: t - timestamp; v - int data

putLong

public void putLong(long t,
                    long v)

put long data.

Parameters:: t - timestamp; v - long data

putFloat

public void putFloat(long t,
                     float v)

put float data.

Parameters:: t - timestamp; v - float data

putDouble

public void putDouble(long t,
                      double v)

put double data.

Parameters:: t - timestamp; v - double data

putBinary

public void putBinary(long t,
                      Binary v)

put binary data.

Parameters:: t - timestamp; v - binary data.

putVector

public void putVector(long t,
                      TsPrimitiveType[] v)

put vector data.

Parameters:: t - timestamp; v - vector data.

getBoolean
```
public boolean getBoolean()
```

setBoolean
```
public void setBoolean(boolean v)
```

getInt
```
public int getInt()
```

setInt
```
public void setInt(int v)
```

getLong
```
public long getLong()
```

setLong
```
public void setLong(long v)
```

getFloat
```
public float getFloat()
```

setFloat
```
public void setFloat(float v)
```

getDouble
```
public double getDouble()
```

setDouble
```
public void setDouble(double v)
```

getBinary
```
public Binary getBinary()
```

setBinary
```
public void setBinary(Binary v)
```

getVector
```
public TsPrimitiveType[] getVector()
```

setVector

public void setVector(TsPrimitiveType[] v)

setTime
```
public void setTime(long v)
```

putAnObject

public void putAnObject(long t,
                        Object v)

put an object.

Parameters:: t - timestamp; v - object

length
```
public int length()
```

getTimeByIndex
```
public long getTimeByIndex(int idx)
```
Get the idx th timestamp by the time ascending order

getLongByIndex
```
public long getLongByIndex(int idx)
```
Get the idx th long value by the time ascending order

getDoubleByIndex
```
public double getDoubleByIndex(int idx)
```
Get the idx th double value by the time ascending order

getIntByIndex
```
public int getIntByIndex(int idx)
```
Get the idx th int value by the time ascending order

getFloatByIndex
```
public float getFloatByIndex(int idx)
```
Get the idx th float value by the time ascending order

getBinaryByIndex
```
public Binary getBinaryByIndex(int idx)
```
Get the idx th binary value by the time ascending order

getBooleanByIndex
```
public boolean getBooleanByIndex(int idx)
```
Get the idx th boolean value by the time ascending order

getVectorByIndex
```
public TsPrimitiveType[] getVectorByIndex(int idx)
```
Get the idx th vector value by the time ascending order

getLastPairBeforeOrEqualTimestamp

public TimeValuePair getLastPairBeforeOrEqualTimestamp(long queryTime)

getValueInTimestamp

public Object getValueInTimestamp(long time)

getMaxTimestamp
```
public long getMaxTimestamp()
```

getMinTimestamp
```
public long getMinTimestamp()
```

getBatchDataIterator

public org.apache.iotdb.tsfile.read.common.BatchData.BatchDataIterator getBatchDataIterator()

getBatchDataIterator
```
public IBatchDataIterator getBatchDataIterator(int subIndex)
```
Only used for the batch data of vector time series.

serializeData
```
public void serializeData(DataOutputStream outputStream)
                   throws IOException
```
For any implementation of BatchData, the data serializing sequence must equal the one of writing, otherwise after deserializing the sequence will be reversed

Throws:

IOException

resetBatchData
```
public void resetBatchData()
```
This method is used to reset batch data when more than one group by aggregation functions visit the same batch data

resetBatchData

public void resetBatchData(int readCurArrayIndex,
                           int readCurListIndex)

getReadCurListIndex
```
public int getReadCurListIndex()
```

getReadCurArrayIndex
```
public int getReadCurArrayIndex()
```

flip
```
public BatchData flip()
```
When put data, the writeIndex increases while the readIndex remains 0. For ascending read, we could read from 0 to writeIndex. So no need to flip.

Class BatchData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CAPACITY_THRESHOLD

capacity

dataType

batchDataType

readCurListIndex

readCurArrayIndex

writeCurListIndex

writeCurArrayIndex

count

timeRet

booleanRet

intRet

longRet

floatRet

doubleRet

binaryRet

vectorRet

Constructor Detail

BatchData

BatchData

Method Detail

isEmpty

hasCurrent

next

currentTime

currentValue

currentTsPrimitiveType

getDataType

setDataType

getBatchDataType

init

putBoolean

putInt

putLong

putFloat

putDouble

putBinary

putVector

getBoolean

setBoolean

getInt

setInt

getLong

setLong

getFloat

setFloat

getDouble

setDouble

getBinary

setBinary

getVector

setVector

setTime

putAnObject

length

getTimeByIndex

getLongByIndex

getDoubleByIndex

getIntByIndex

getFloatByIndex

getBinaryByIndex

getBooleanByIndex

getVectorByIndex

getLastPairBeforeOrEqualTimestamp

getValueInTimestamp

getMaxTimestamp

getMinTimestamp

getBatchDataIterator

getBatchDataIterator

serializeData

resetBatchData

resetBatchData

getReadCurListIndex