org.apache.parquet.compression

Interface CompressionCodecFactory

public interface CompressionCodecFactory

Factory for creating (and potentially caching) CompressionCodecFactory.BytesInputCompressor and CompressionCodecFactory.BytesInputDecompressor instances to compress/decompress page data.

The factory instance shall be released after use. The compressor/decompressor instances shall not be used after release.

See Also:

release()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CompressionCodecFactory.BytesInputCompressor Compressor instance of a specific codec to be used for compressing page data.
static interface	CompressionCodecFactory.BytesInputDecompressor Decompressor instance of a specific codec to be used for decompressing page data.

Method Summary

Modifier and Type	Method and Description
CompressionCodecFactory.BytesInputCompressor	getCompressor(CompressionCodecName codecName) Returns a CompressionCodecFactory.BytesInputCompressor instance for the specified codec name to be used for compressing page data.
CompressionCodecFactory.BytesInputDecompressor	getDecompressor(CompressionCodecName codecName) Returns a CompressionCodecFactory.BytesInputDecompressor instance for the specified codec name to be used for decompressing page data.
void	release() Releasing this factory instance.

Method Detail

getCompressor

CompressionCodecFactory.BytesInputCompressor getCompressor(CompressionCodecName codecName)

Returns a CompressionCodecFactory.BytesInputCompressor instance for the specified codec name to be used for compressing page data.

The compressor is not thread-safe, so one instance for each working thread is required.

Parameters:

codecName - the codec name which the compressor instance is to be returned

Returns:

the compressor instance for the specified codec name

See Also:

CompressionCodecFactory.BytesInputCompressor.release()

getDecompressor

CompressionCodecFactory.BytesInputDecompressor getDecompressor(CompressionCodecName codecName)

Returns a CompressionCodecFactory.BytesInputDecompressor instance for the specified codec name to be used for decompressing page data.

The decompressor is not thread-safe, so one instance for each working thread is required.

Parameters:

codecName - the codec name which the decompressor instance is to be returned

Returns:

the decompressor instance for the specified codec name

See Also:

CompressionCodecFactory.BytesInputDecompressor.release()

release

void release()

Releasing this factory instance.

Each compressor/decompressor instance shall be released before invoking this. Nor the compressor/decompressor instances retrieved from this factory nor this factory instance itself shall be used after release.

See Also:

CompressionCodecFactory.BytesInputCompressor.release(), CompressionCodecFactory.BytesInputDecompressor.release()