Package com.clickhouse.client

Class ClickHouseFile

java.lang.Object

com.clickhouse.client.ClickHouseFile

All Implemented Interfaces:

Serializable

public class ClickHouseFile
extends Object
implements Serializable

Wrapper of File with additional information like compression and format.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ClickHouseFile	NULL	Null file which has no compression and format.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClickHouseFile(File file, ClickHouseCompression compress, int compressLevel, ClickHouseFormat format)

Method Summary

Modifier and Type	Method	Description
ClickHouseInputStream	asInputStream()	Creates an input stream for reading the file.
ClickHouseOutputStream	asOutputStream()	Creates an output stream for writing data into the file.
ClickHouseCompression	getCompressionAlgorithm()	Gets compression algorithm.
int	getCompressionLevel()	Gets compression level.
File	getFile()	Gets file, which only works when isAvailable() returns true.
ClickHouseFormat	getFormat()	Gets file format, which could be null.
boolean	hasFormat()	Checks if the file format is defined or not.
boolean	isAvailable()	Checks if the file is available or not.
boolean	isCompressed()	Checks if the file is compressed or not.
static ClickHouseFile	of(File file)
static ClickHouseFile	of(File file, ClickHouseCompression compression, int compressionLevel, ClickHouseFormat format)
static ClickHouseFile	of(String file)
static ClickHouseFile	of(String file, ClickHouseCompression compression, int compressionLevel, ClickHouseFormat format)
static ClickHouseFile	of(Path path)

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final ClickHouseFile NULL

Null file which has no compression and format.

Constructor Detail

ClickHouseFile

protected ClickHouseFile(File file,
                         ClickHouseCompression compress,
                         int compressLevel,
                         ClickHouseFormat format)

Method Detail

of

public static ClickHouseFile of(File file)

of

public static ClickHouseFile of(Path path)

of

public static ClickHouseFile of(String file)

of

public static ClickHouseFile of(String file,
                                ClickHouseCompression compression,
                                int compressionLevel,
                                ClickHouseFormat format)

of

public static ClickHouseFile of(File file,
                                ClickHouseCompression compression,
                                int compressionLevel,
                                ClickHouseFormat format)

asInputStream

public ClickHouseInputStream asInputStream()

Creates an input stream for reading the file.

Returns:

non-null input stream for reading the file

asOutputStream

public ClickHouseOutputStream asOutputStream()

Creates an output stream for writing data into the file.

Returns:

non-null input stream for writing data into the file

getFile

public File getFile()

Gets file, which only works when isAvailable() returns true.

Returns:

non-null file, except null for NULL

getFormat

public ClickHouseFormat getFormat()

Gets file format, which could be null. Use hasFormat() to check first.

Returns:

file format, could be null

getCompressionAlgorithm

public ClickHouseCompression getCompressionAlgorithm()

Gets compression algorithm.

Returns:

non-null compression algorithm

getCompressionLevel

public int getCompressionLevel()

Gets compression level.

Returns:

compression level, which is always greater than or equal to zero

hasFormat

public boolean hasFormat()

Checks if the file format is defined or not.

Returns:

true if the file format is defined; false otherwise

isAvailable

public boolean isAvailable()

Checks if the file is available or not.

Returns:

true if the file is available; false otherwise

isCompressed

public boolean isCompressed()

Checks if the file is compressed or not.

Returns:

true if the file is compressed; false otherwise