Package com.clickhouse.data

Class ClickHouseFile

java.lang.Object

com.clickhouse.data.ClickHousePassThruStream

com.clickhouse.data.ClickHouseFile

All Implemented Interfaces:

Serializable

public class ClickHouseFile
extends ClickHousePassThruStream

Wrapper of File with additional information like compression and format.

See Also:

• Serialized Form

Field Summary

Fields

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

Fields inherited from class com.clickhouse.data.ClickHousePassThruStream

ERROR_NO_INPUT, ERROR_NO_OUTPUT, TYPE_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
File	getFile()	Gets file.
ClickHouseInputStream	getInputStream()	Gets the input stream for reading.
ClickHouseOutputStream	getOutputStream()	Gets the output stream for writing.
boolean	hasInput()	Checks if input stream is available or not.
boolean	hasOutput()	Checks if output stream is available or not.
boolean	isRecognized()	Checks if the given file is recogonized or not.
ClickHouseInputStream	newInputStream(int bufferSize, Runnable postCloseAction)	Creates a wrapped input stream for reading.
ClickHouseOutputStream	newOutputStream(int bufferSize, Runnable postCloseAction)	Creates a wrapped output stream for writing.
static ClickHouseFile	of(ClickHouseInputStream input, ClickHouseCompression compression, int compressionLevel, ClickHouseFormat format)
static ClickHouseFile	of(ClickHousePassThruStream stream)
static ClickHouseFile	of(File file)
static ClickHouseFile	of(File file, ClickHouseCompression compression, int compressionLevel, ClickHouseFormat format)
static ClickHouseFile	of(File file, ClickHouseCompression compression, ClickHouseFormat format)
static ClickHouseFile	of(InputStream input, 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(String file, ClickHouseCompression compression, ClickHouseFormat format)
static ClickHouseFile	of(Path path)

Methods inherited from class com.clickhouse.data.ClickHousePassThruStream

getCompressionAlgorithm, getCompressionLevel, getFormat, hasCompression, hasFormat, isCompressed, of, of, of, of, of, of

Methods inherited from class java.lang.Object

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

Field Details

NULL

public static final ClickHouseFile NULL

Null file which has no compression and format.

Constructor Details

ClickHouseFile

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

Method Details

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,
 ClickHouseFormat format)

of

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

of

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

of

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

of

public static ClickHouseFile of(ClickHousePassThruStream stream)

of

public static ClickHouseFile of(ClickHouseInputStream input,
 ClickHouseCompression compression,
 int compressionLevel,
 ClickHouseFormat format)

of

public static ClickHouseFile of(InputStream input,
 ClickHouseCompression compression,
 int compressionLevel,
 ClickHouseFormat format)

getInputStream

public ClickHouseInputStream getInputStream()

Description copied from class: ClickHousePassThruStream

Gets the input stream for reading. Please pay attention that the returned input stream has nothing to do with this pass-thru stream, as getInputStream().getUnderlyingStream() is always ClickHousePassThruStream.NULL.

Overrides:

getInputStream in class ClickHousePassThruStream

Returns:

non-null input stream

newInputStream

public ClickHouseInputStream newInputStream(int bufferSize,
 Runnable postCloseAction)

Description copied from class: ClickHousePassThruStream

Creates a wrapped input stream for reading. Calling this method multiple times will generate multiple ClickHouseInputStream instances pointing to the same input stream, so it does not make sense to call this more than once. Unlike ClickHousePassThruStream.getInputStream(), the returned input stream is associated with this pass-thru stream, so newInputStream(...).getUnderlyingStream() simply returns the current pass-thru stream.

Overrides:

newInputStream in class ClickHousePassThruStream

Parameters:

bufferSize - buffer size which is always greater than zero(usually 4096 or larger)

postCloseAction - custom action will be performed right after closing the input stream

Returns:

non-null wrapped input stream

getOutputStream

public ClickHouseOutputStream getOutputStream()

Description copied from class: ClickHousePassThruStream

Gets the output stream for writing. Please pay attention that the returned output stream has nothing to do with this pass-thru stream, as getOutputStream().getUnderlyingStream() is always ClickHousePassThruStream.NULL.

Overrides:

getOutputStream in class ClickHousePassThruStream

Returns:

non-null output stream

newOutputStream

public ClickHouseOutputStream newOutputStream(int bufferSize,
 Runnable postCloseAction)

Description copied from class: ClickHousePassThruStream

Creates a wrapped output stream for writing. Calling this method multiple times will generate multiple ClickHouseOutputStream instances, so it does not make sense to call this more than once. Unlike ClickHousePassThruStream.getOutputStream(), the returned output stream is associated with this pass-thru stream, so newOutputStream(...).getUnderlyingStream() simply returns the current pass-thru stream.

Overrides:

newOutputStream in class ClickHousePassThruStream

Parameters:

bufferSize - buffer size which is always greater than zero(usually 4096 or larger)

postCloseAction - custom action will be performed right after closing the output stream

Returns:

non-null wrapped output stream

getFile

public File getFile()

Gets file. Use #hasInput() or #hasOutput() to check file availability first.

Returns:

file, could be null

isRecognized

public boolean isRecognized()

Checks if the given file is recogonized or not. Same as hasCompression() || hasFormat().

Returns:

true if the file is recogonized

hasInput

public boolean hasInput()

Description copied from class: ClickHousePassThruStream

Checks if input stream is available or not.

Overrides:

hasInput in class ClickHousePassThruStream

Returns:

true if input stream is available; false otherwise

hasOutput

public boolean hasOutput()

Description copied from class: ClickHousePassThruStream

Checks if output stream is available or not.

Overrides:

hasOutput in class ClickHousePassThruStream

Returns:

true if output stream is available; false otherwise