org.apache.iotdb.tsfile.v2.read

Class TsFileSequenceReaderForV2

java.lang.Object

org.apache.iotdb.tsfile.read.TsFileSequenceReader

org.apache.iotdb.tsfile.v2.read.TsFileSequenceReaderForV2

All Implemented Interfaces:

AutoCloseable

public class TsFileSequenceReaderForV2
extends TsFileSequenceReader
implements AutoCloseable

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.iotdb.tsfile.read.TsFileSequenceReader

TsFileSequenceReader.LocateStatus

Field Summary

Fields inherited from class org.apache.iotdb.tsfile.read.TsFileSequenceReader

config, file, fileMetadataPos, fileMetadataSize, tsFileInput, tsFileMetaData

Constructor Summary

Constructors

Constructor and Description
TsFileSequenceReaderForV2(String file) Create a file reader of the given file.
TsFileSequenceReaderForV2(String file, boolean loadMetadataSize) construct function for TsFileSequenceReader.
TsFileSequenceReaderForV2(TsFileInput input) Create a file reader of the given file.
TsFileSequenceReaderForV2(TsFileInput input, boolean loadMetadataSize) construct function for TsFileSequenceReader.
TsFileSequenceReaderForV2(TsFileInput input, long fileMetadataPos, int fileMetadataSize) construct function for TsFileSequenceReader.

Method Summary

Modifier and Type	Method and Description
List<String>	getAllDevices()
Map<String,List<TimeseriesMetadata>>	getAllTimeseriesMetadata(boolean needChunkMetadata)
boolean	isComplete() whether the file is a complete TsFile: only if the head magic and tail magic string exists.
ChunkGroupHeader	readChunkGroupFooter() read data from current position of the input, and deserialize it to a CHUNK_GROUP_FOOTER.
ChunkHeader	readChunkHeader() read data from current position of the input, and deserialize it to a CHUNK_HEADER.
Map<String,List<ChunkMetadata>>	readChunkMetadataInDevice(String device) read all ChunkMetaDatas of given device
ArrayList<ChunkMetadata>	readChunkMetaDataList(TimeseriesMetadata timeseriesMetaData) get ChunkMetaDatas in given TimeseriesMetaData
TsFileMetadata	readFileMetadata() this function does not modify the position of the file reader.
List<ITimeSeriesMetadata>	readITimeseriesMetadata(String device, Set<String> measurements)
Chunk	readMemChunk(ChunkMetadata metaData) read memory chunk.
PageHeader	readPageHeader(TSDataType type) not thread safe.
TimeseriesMetadata	readTimeseriesMetadata(Path path, boolean ignoreNotExists)
List<TimeseriesMetadata>	readTimeseriesMetadata(Path path, Set<String> allSensors)
long	readVersion()
String	readVersionNumberV2() this function reads version number and checks compatibility of TsFile.

Methods inherited from class org.apache.iotdb.tsfile.read.TsFileSequenceReader

binarySearchInTimeseriesMetadataList, checkChunkAndPagesStatistics, close, fileSize, getAlignedChunkMetadata, getAllDevicesIteratorWithIsAligned, getAllMeasurements, getAllPaths, getChunkMetadataList, getChunkMetadataList, getDeviceMeasurementsMap, getDeviceNameInRange, getFileMetadataPos, getFileMetadataSize, getFileName, getIChunkMetadataList, getMaxPlanIndex, getMeasurementChunkMetadataListMapIterator, getMetadataAndEndOffset, getMetadataIndexNode, getMinPlanIndex, getPathsIterator, getTsFileMetadataSize, hashCode, loadMetadataSize, position, position, readBloomFilter, readChunkGroupHeader, readChunkGroupHeader, readChunkHeader, readCompressedPage, readData, readData, readDeviceMetadata, readHeadMagic, readIChunkMetaDataList, readITimeseriesMetadata, readMarker, readMemChunk, readPage, readPageHeader, readPlanIndex, readRaw, readTailMagic, readVersionNumber, selfCheck, selfCheckWithInfo, skipPageData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

TsFileSequenceReaderForV2

public TsFileSequenceReaderForV2(String file)
                          throws IOException

Create a file reader of the given file. The reader will read the tail of the file to get the file metadata size.Then the reader will skip the first TSFileConfig.MAGIC_STRING.getBytes().length + TSFileConfig.NUMBER_VERSION.getBytes().length bytes of the file for preparing reading real data.

Parameters:

file - the data file

Throws:

IOException - If some I/O error occurs

TsFileSequenceReaderForV2

public TsFileSequenceReaderForV2(String file,
                                 boolean loadMetadataSize)
                          throws IOException

construct function for TsFileSequenceReader.

Parameters:

file - -given file name

loadMetadataSize - -whether load meta data size

Throws:

IOException

TsFileSequenceReaderForV2

public TsFileSequenceReaderForV2(TsFileInput input)
                          throws IOException

Create a file reader of the given file. The reader will read the tail of the file to get the file metadata size.Then the reader will skip the first TSFileConfig.MAGIC_STRING.getBytes().length + TSFileConfig.NUMBER_VERSION.getBytes().length bytes of the file for preparing reading real data.

Parameters:

input - given input

Throws:

IOException

TsFileSequenceReaderForV2

public TsFileSequenceReaderForV2(TsFileInput input,
                                 boolean loadMetadataSize)
                          throws IOException

construct function for TsFileSequenceReader.

Parameters:

input - -given input

loadMetadataSize - -load meta data size

Throws:

IOException

TsFileSequenceReaderForV2

public TsFileSequenceReaderForV2(TsFileInput input,
                                 long fileMetadataPos,
                                 int fileMetadataSize)

construct function for TsFileSequenceReader.

Parameters:

input - the input of a tsfile. The current position should be a markder and then a chunk Header, rather than the magic number

fileMetadataPos - the position of the file metadata in the TsFileInput from the beginning of the input to the current position

fileMetadataSize - the byte size of the file metadata in the input

Method Detail

isComplete

public boolean isComplete()
                   throws IOException

whether the file is a complete TsFile: only if the head magic and tail magic string exists.

Overrides:

isComplete in class TsFileSequenceReader

Throws:

IOException

readVersionNumberV2

public String readVersionNumberV2()
                           throws IOException

this function reads version number and checks compatibility of TsFile.

Throws:

IOException

readFileMetadata

public TsFileMetadata readFileMetadata()
                                throws IOException

this function does not modify the position of the file reader.

Overrides:

readFileMetadata in class TsFileSequenceReader

Throws:

IOException - io error

readTimeseriesMetadata

public TimeseriesMetadata readTimeseriesMetadata(Path path,
                                                 boolean ignoreNotExists)
                                          throws IOException

Overrides:

readTimeseriesMetadata in class TsFileSequenceReader

Throws:

IOException

readTimeseriesMetadata

public List<TimeseriesMetadata> readTimeseriesMetadata(Path path,
                                                       Set<String> allSensors)
                                                throws IOException

Overrides:

readTimeseriesMetadata in class TsFileSequenceReader

Throws:

IOException

readITimeseriesMetadata

public List<ITimeSeriesMetadata> readITimeseriesMetadata(String device,
                                                         Set<String> measurements)
                                                  throws IOException

Overrides:

readITimeseriesMetadata in class TsFileSequenceReader

Throws:

IOException

getAllDevices

public List<String> getAllDevices()
                           throws IOException

Overrides:

getAllDevices in class TsFileSequenceReader

Throws:

IOException

readChunkMetadataInDevice

public Map<String,List<ChunkMetadata>> readChunkMetadataInDevice(String device)
                                                          throws IOException

read all ChunkMetaDatas of given device

Overrides:

readChunkMetadataInDevice in class TsFileSequenceReader

Parameters:

device - name

Returns:

measurement -> ChunkMetadata list

Throws:

IOException - io error

getAllTimeseriesMetadata

public Map<String,List<TimeseriesMetadata>> getAllTimeseriesMetadata(boolean needChunkMetadata)
                                                              throws IOException

Overrides:

getAllTimeseriesMetadata in class TsFileSequenceReader

Throws:

IOException

readChunkGroupFooter

public ChunkGroupHeader readChunkGroupFooter()
                                      throws IOException

read data from current position of the input, and deserialize it to a CHUNK_GROUP_FOOTER.
This method is not threadsafe.

Returns:

a CHUNK_GROUP_FOOTER

Throws:

IOException - io error

readChunkHeader

public ChunkHeader readChunkHeader()
                            throws IOException

read data from current position of the input, and deserialize it to a CHUNK_HEADER.
This method is not threadsafe.

Returns:

a CHUNK_HEADER

Throws:

IOException - io error

readMemChunk

public Chunk readMemChunk(ChunkMetadata metaData)
                   throws IOException

read memory chunk.

Overrides:

readMemChunk in class TsFileSequenceReader

Parameters:

metaData - -given chunk meta data

Returns:

-chunk

Throws:

IOException

readPageHeader

public PageHeader readPageHeader(TSDataType type)
                          throws IOException

not thread safe.

Parameters:

type - given tsfile data type

Throws:

IOException

readVersion

public long readVersion()
                 throws IOException

Throws:

IOException

readChunkMetaDataList

public ArrayList<ChunkMetadata> readChunkMetaDataList(TimeseriesMetadata timeseriesMetaData)
                                               throws IOException

get ChunkMetaDatas in given TimeseriesMetaData

Overrides:

readChunkMetaDataList in class TsFileSequenceReader

Returns:

List of ChunkMetaData

Throws:

IOException