Package org.apache.hop.core.compress.hadoopsnappy

Class HadoopSnappyCompressionProvider

java.lang.Object

org.apache.hop.core.compress.hadoopsnappy.HadoopSnappyCompressionProvider

All Implemented Interfaces:

ICompressionProvider

@CompressionPlugin(id="HADOOPSNAPPY",
                   name="Hadoop-snappy",
                   description="Hadoop Snappy compression")
public class HadoopSnappyCompressionProvider
extends Object
implements ICompressionProvider

Field Summary

Fields

Modifier and Type	Field	Description
static int	IO_COMPRESSION_CODEC_SNAPPY_DEFAULT_BUFFERSIZE

Constructor Summary

Constructors

Constructor	Description
HadoopSnappyCompressionProvider()

Method Summary

Modifier and Type	Method	Description
HadoopSnappyCompressionInputStream	createInputStream(InputStream in)	Creates an input stream that decompresses data (according to the provider's implementation)
HadoopSnappyCompressionOutputStream	createOutputStream(OutputStream out)	Creates an output stream that compresses data (according to the provider's implementation)
static Object	getActiveSnappyShim()	Locate the Snappy Shim for the active Hadoop Configuration via the Hadoop Configuration Util
String	getDefaultExtension()	Gets the default file extension for this provider.
String	getDescription()	Gets the name of this provider.
String	getName()	Gets the name of this provider.
static boolean	isHadoopSnappyAvailable()	Tests whether hadoop-snappy (not to be confused with other java-based snappy implementations such as jsnappy or snappy-java) plus the native snappy libraries are available.
boolean	supportsInput()	Whether this compression provider supports input streams
boolean	supportsOutput()	Whether this compression provider supports output streams

Methods inherited from class java.lang.Object

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

Field Detail

IO_COMPRESSION_CODEC_SNAPPY_DEFAULT_BUFFERSIZE

public static final int IO_COMPRESSION_CODEC_SNAPPY_DEFAULT_BUFFERSIZE

See Also:

Constant Field Values

Constructor Detail

HadoopSnappyCompressionProvider

public HadoopSnappyCompressionProvider()

Method Detail

getActiveSnappyShim

public static Object getActiveSnappyShim()
                                  throws Exception

Locate the Snappy Shim for the active Hadoop Configuration via the Hadoop Configuration Util

Returns:

A org.apache.hop.hadoop.shim.spi.SnappyShim to interact with Snappy

Throws:

Exception - Error locating a valid Snappy shim:

• org.apache.hop.hadoop.hive.jdbc.HadoopConfigurationUtil could not be located
• No active Hadoop configuration
• Active Hadoop configuration doesn't support Snappy

isHadoopSnappyAvailable

public static boolean isHadoopSnappyAvailable()

Tests whether hadoop-snappy (not to be confused with other java-based snappy implementations such as jsnappy or snappy-java) plus the native snappy libraries are available.

Returns:

true if hadoop-snappy is available on the classpath

createInputStream

public HadoopSnappyCompressionInputStream createInputStream(InputStream in)
                                                     throws IOException

Description copied from interface: ICompressionProvider

Creates an input stream that decompresses data (according to the provider's implementation)

Specified by:

createInputStream in interface ICompressionProvider

Parameters:

in - An existing input stream to wrap

Returns:

a CompressionInputStream object that decompresses incoming data

Throws:

IOException

supportsInput

public boolean supportsInput()

Description copied from interface: ICompressionProvider

Whether this compression provider supports input streams

Specified by:

supportsInput in interface ICompressionProvider

Returns:

true if the provider supports input streams, false otherwise

createOutputStream

public HadoopSnappyCompressionOutputStream createOutputStream(OutputStream out)
                                                       throws IOException

Description copied from interface: ICompressionProvider

Creates an output stream that compresses data (according to the provider's implementation)

Specified by:

createOutputStream in interface ICompressionProvider

Parameters:

out - An existing output stream to wrap

Returns:

a CompressionOutputStream object that compresses outgoing data

Throws:

IOException

supportsOutput

public boolean supportsOutput()

Description copied from interface: ICompressionProvider

Whether this compression provider supports output streams

Specified by:

supportsOutput in interface ICompressionProvider

Returns:

true if the provider supports output streams, false otherwise

getDescription

public String getDescription()

Description copied from interface: ICompressionProvider

Gets the name of this provider. Used for display e.g.

Specified by:

getDescription in interface ICompressionProvider

Returns:

A String containing a description of this provider

getName

public String getName()

Description copied from interface: ICompressionProvider

Gets the name of this provider. Used for display and as a reference in saved artifacts (pipelines, e.g.)

Specified by:

getName in interface ICompressionProvider

Returns:

A String containing the name of this provider

getDefaultExtension

public String getDefaultExtension()

Description copied from interface: ICompressionProvider

Gets the default file extension for this provider. If the streams are wrapped in File streams, this method can be used to determine an appropriate extension to append to the filename so the file will be recognized as an artifact of the compression mechanism (.zip, .bz2, e.g.)

Specified by:

getDefaultExtension in interface ICompressionProvider

Returns:

A String containing the default file extension for this provider