adams.flow.transformer
Class AbstractSingleCompress

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.AbstractSingleCompress

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

Direct Known Subclasses:

Bzip2, GZIP, Lzf, Lzma

public abstract class AbstractSingleCompress
extends AbstractTransformer

Ancestor for compression algorithms that only take a single file, like gzip.

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected int	m_BufferSize the buffer size to use.
protected PlaceholderFile	m_Output the filename of the GZIP output.
protected boolean	m_RemoveInputFile whether to remove the original input file.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

AbstractSingleCompress()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	bufferSizeTipText() Returns the tip text for this property.
protected abstract String	compress(File inFile, File outFile) Compresses the file.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Performs the actual transformation.
Class[]	generates() Returns the class of objects that it generates.
int	getBufferSize() Returns the buffer size for the stream.
protected abstract String	getDefaultExtension() Returns the default extension that the compressed archive has, e.g., ".gz" for gzipped files.
PlaceholderFile	getOutput() Returns the GZIP output filename.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
boolean	getRemoveInputFile() Returns whether to remove the original input after the file has been compressed.
abstract String	outputTipText() Returns the tip text for this property.
String	removeInputFileTipText() Returns the tip text for this property.
void	setBufferSize(int value) Sets the buffer size for the stream.
void	setOutput(PlaceholderFile value) Sets the GZIP output filename.
void	setRemoveInputFile(boolean value) Sets whether to remove the original input after the file has been compressed.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, postExecute, reset, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, globalInfo, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Field Detail

m_RemoveInputFile

protected boolean m_RemoveInputFile

whether to remove the original input file.

m_Output

protected PlaceholderFile m_Output

the filename of the GZIP output.

m_BufferSize

protected int m_BufferSize

the buffer size to use.

Constructor Detail

AbstractSingleCompress

public AbstractSingleCompress()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

getDefaultExtension

protected abstract String getDefaultExtension()

Returns the default extension that the compressed archive has, e.g., ".gz" for gzipped files.

Returns:

the extension, including the dot

setRemoveInputFile

public void setRemoveInputFile(boolean value)

Sets whether to remove the original input after the file has been compressed.

Parameters:

value - true if the input file should be removed

getRemoveInputFile

public boolean getRemoveInputFile()

Returns whether to remove the original input after the file has been compressed.

Returns:

true if the input file will be removed

removeInputFileTipText

public String removeInputFileTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setOutput

public void setOutput(PlaceholderFile value)

Sets the GZIP output filename.

Parameters:

value - the filename

getOutput

public PlaceholderFile getOutput()

Returns the GZIP output filename.

Returns:

the filename

outputTipText

public abstract String outputTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setBufferSize

public void setBufferSize(int value)

Sets the buffer size for the stream.

Parameters:

value - the size in bytes

getBufferSize

public int getBufferSize()

Returns the buffer size for the stream.

Returns:

the size in bytes

bufferSizeTipText

public String bufferSizeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

the accepted input

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

the generated output

compress

protected abstract String compress(File inFile,
                                   File outFile)

Compresses the file.

Parameters:

inFile - the uncompressed input file

outFile - the compressed output file

Returns:

null if successfully compressed, otherwise error message

doExecute

protected String doExecute()

Performs the actual transformation.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message