com.emc.vipr.transform.compression

Class CompressionTransformFactory

java.lang.Object

com.emc.vipr.transform.TransformFactory<CompressionOutputTransform,CompressionInputTransform>

com.emc.vipr.transform.compression.CompressionTransformFactory

All Implemented Interfaces:

java.lang.Comparable<TransformFactory<OutputTransform,InputTransform>>

public class CompressionTransformFactory
extends TransformFactory<CompressionOutputTransform,CompressionInputTransform>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompressionTransformFactory.LzmaProfile

Field Summary

Fields

Modifier and Type	Field and Description
int	compressionLevel
TransformConstants.CompressionMode	compressMode
static CompressionTransformFactory.LzmaProfile[]	LZMA_COMPRESSION_PROFILE Map LZMA compression parameters into the standard 0-9 compression levels.

Constructor Summary

Constructors

Constructor and Description
CompressionTransformFactory()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDecode(java.lang.String transformClass, java.lang.String config, java.util.Map<java.lang.String,java.lang.String> metadata) Checks whether this class can decode the given transformation configuration.
int	getCompressionLevel()
TransformConstants.CompressionMode	getCompressMode()
CompressionInputTransform	getInputTransform(java.lang.String transformConfig, java.io.InputStream streamToDecode, java.util.Map<java.lang.String,java.lang.String> metadata) Gets the "input" transform for the given class and metadata.
CompressionOutputTransform	getOutputTransform(java.io.InputStream streamToEncode, java.util.Map<java.lang.String,java.lang.String> metadataToEncode) Gets an "output" transform for the factory in its current state.
CompressionOutputTransform	getOutputTransform(java.io.OutputStream streamToEncodeTo, java.util.Map<java.lang.String,java.lang.String> metadataToEncode) Gets an "output" transform for the factory in its current state.
java.lang.String	getTransformClass() Gets the high-level class of transform that this factory provides.
static long	memoryRequiredForLzma(CompressionTransformFactory.LzmaProfile profile)
static long	memoryRequiredForLzma(int compressionLevel)
void	setCompressionLevel(int compressionLevel)
void	setCompressMode(TransformConstants.CompressionMode compressMode)

Methods inherited from class com.emc.vipr.transform.TransformFactory

canDecode, compareTo, getPriority, setPriority, splitTransformConfig

Methods inherited from class java.lang.Object

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

Field Detail

compressMode

public TransformConstants.CompressionMode compressMode

compressionLevel

public int compressionLevel

LZMA_COMPRESSION_PROFILE

public static CompressionTransformFactory.LzmaProfile[] LZMA_COMPRESSION_PROFILE

Map LZMA compression parameters into the standard 0-9 compression levels.

Constructor Detail

CompressionTransformFactory

public CompressionTransformFactory()

Method Detail

getCompressMode

public TransformConstants.CompressionMode getCompressMode()

setCompressMode

public void setCompressMode(TransformConstants.CompressionMode compressMode)

getCompressionLevel

public int getCompressionLevel()

setCompressionLevel

public void setCompressionLevel(int compressionLevel)

getOutputTransform

public CompressionOutputTransform getOutputTransform(java.io.OutputStream streamToEncodeTo,
                                            java.util.Map<java.lang.String,java.lang.String> metadataToEncode)
                                              throws java.io.IOException

Description copied from class: TransformFactory

Gets an "output" transform for the factory in its current state. This will be used to transform raw data on its way "out" to the server.

Specified by:

getOutputTransform in class TransformFactory<CompressionOutputTransform,CompressionInputTransform>

Returns:

a transform that can encode the outbound object stream.

Throws:

java.io.IOException

getOutputTransform

public CompressionOutputTransform getOutputTransform(java.io.InputStream streamToEncode,
                                            java.util.Map<java.lang.String,java.lang.String> metadataToEncode)
                                              throws java.io.IOException,
                                                     TransformException

Description copied from class: TransformFactory

Gets an "output" transform for the factory in its current state. This will be used to transform raw data on its way "out" to the server. This version gets an output transform in "pull" mode that uses an input stream to filter the data. This is useful for situations where you need to pump data to an output stream like when using an HTTP output stream.

Specified by:

getOutputTransform in class TransformFactory<CompressionOutputTransform,CompressionInputTransform>

Returns:

a transform that can encode the outbound object stream.

Throws:

java.io.IOException

TransformException

getInputTransform

public CompressionInputTransform getInputTransform(java.lang.String transformConfig,
                                          java.io.InputStream streamToDecode,
                                          java.util.Map<java.lang.String,java.lang.String> metadata)
                                            throws java.io.IOException

Description copied from class: TransformFactory

Gets the "input" transform for the given class and metadata.

Specified by:

getInputTransform in class TransformFactory<CompressionOutputTransform,CompressionInputTransform>

Parameters:

transformConfig - the configuration of the transformClass.

metadata - metadata extracted from the inbound object (used to fine-tune the transformation and/or provide metadata to also be transformed).

Returns:

a transform that can decode the inbound object stream.

Throws:

java.io.IOException

getTransformClass

public java.lang.String getTransformClass()

Description copied from class: TransformFactory

Gets the high-level class of transform that this factory provides. The transform engine will use this to test whether the registered factory can decode the given object.

Specified by:

getTransformClass in class TransformFactory<CompressionOutputTransform,CompressionInputTransform>

Returns:

the transformation class, e.g. "COMP" for compression or "ENC" for encryption.

canDecode

public boolean canDecode(java.lang.String transformClass,
                java.lang.String config,
                java.util.Map<java.lang.String,java.lang.String> metadata)

Checks whether this class can decode the given transformation configuration.

Parameters:

transformClass - the transformation class to check, e.g. "COMP"

config - the configuration for the transformation, e.g. "LZMA/9"

metadata - the additional metadata from the object in case additional fields need to be checked.

Returns:

true if this factory can decode the given object stream.

memoryRequiredForLzma

public static long memoryRequiredForLzma(int compressionLevel)

memoryRequiredForLzma

public static long memoryRequiredForLzma(CompressionTransformFactory.LzmaProfile profile)