Package org.apache.druid.segment.file

Class SegmentFileMapperV10

java.lang.Object

org.apache.druid.segment.file.SegmentFileMapperV10

All Implemented Interfaces:

Closeable, AutoCloseable, SegmentFileMapper

public class SegmentFileMapperV10
extends Object
implements SegmentFileMapper

SegmentFileMapper implementation for V10 segment files.

V10 file format: | version (byte) | meta compression (byte) | meta length (int) | meta json | container 0 | ... | container n |

Constructor Summary

Constructors

Constructor	Description
SegmentFileMapperV10(File segmentFile, SegmentFileMetadata segmentFileMetadata, List<MappedByteBuffer> containers, Map<String,SegmentFileMapperV10> externalMappers)

Method Summary

Modifier and Type	Method	Description
void	close()
static SegmentFileMapperV10	create(File segmentFile, com.fasterxml.jackson.databind.ObjectMapper mapper)	Create a v10 SegmentFileMapper
static SegmentFileMapperV10	create(File segmentFile, com.fasterxml.jackson.databind.ObjectMapper mapper, List<String> externals)	Create a v10 SegmentFileMapper with 'external' attached v10 segment files
Set<String>	getInternalFilenames()	Returns the list of files contained within in the segment file which can be retrieved with SegmentFileMapper.mapFile(String)
SegmentFileMetadata	getSegmentFileMetadata()
ByteBuffer	mapExternalFile(String filename, String name)	Loads a file from an 'external' segment container file, in the same directory as this SegmentFileMapper.
ByteBuffer	mapFile(String name)	Returns a mapped ByteBuffer which of the contents of the internal file, or null if the file is not present in this segment.

Methods inherited from class java.lang.Object

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

Constructor Details

SegmentFileMapperV10

public SegmentFileMapperV10(File segmentFile,
 SegmentFileMetadata segmentFileMetadata,
 List<MappedByteBuffer> containers,
 Map<String,SegmentFileMapperV10> externalMappers)

Method Details

create

public static SegmentFileMapperV10 create(File segmentFile,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 List<String> externals)
                                   throws IOException

Create a v10 SegmentFileMapper with 'external' attached v10 segment files

Parameters:

segmentFile - v10 segment file with name IndexIO.V10_FILE_NAME

mapper - json mapper to deserialize metadata

externals - list of 'external' v10 segment files to attach to this mapper and files that can be referenced using mapExternalFile(String, String)

Returns:

v10 SegmentFileMapper using memory mapped ByteBuffer

Throws:

IOException

create

public static SegmentFileMapperV10 create(File segmentFile,
 com.fasterxml.jackson.databind.ObjectMapper mapper)
                                   throws IOException

Create a v10 SegmentFileMapper

Throws:

IOException

getSegmentFileMetadata

public SegmentFileMetadata getSegmentFileMetadata()

getInternalFilenames

public Set<String> getInternalFilenames()

Description copied from interface: SegmentFileMapper

Returns the list of files contained within in the segment file which can be retrieved with SegmentFileMapper.mapFile(String)

Specified by:

getInternalFilenames in interface SegmentFileMapper

mapFile

@Nullable
public ByteBuffer mapFile(String name)
                   throws IOException

Description copied from interface: SegmentFileMapper

Returns a mapped ByteBuffer which of the contents of the internal file, or null if the file is not present in this segment. The file data is from 0 to Buffer.capacity(), Buffer.limit() is equal to the capacity.

Specified by:

mapFile in interface SegmentFileMapper

Throws:

IOException

mapExternalFile

@Nullable
public ByteBuffer mapExternalFile(String filename,
 String name)
                           throws IOException

Description copied from interface: SegmentFileMapper

Loads a file from an 'external' segment container file, in the same directory as this SegmentFileMapper. Legacy implementations do not support this concept, and so just map these files directly, which allows column implementations to use these methods but also still work with older segment formats.

Specified by:

mapExternalFile in interface SegmentFileMapper

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SegmentFileMapper