Package adams.flow.standalone.rats.output

Class BinaryFileWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.output.AbstractRatOutput

adams.flow.standalone.rats.output.BinaryFileWriter

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileWriter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable

public class BinaryFileWriter
extends AbstractRatOutput
implements adams.core.io.FileWriter

Writes incoming binary data (byte array or adams.data.blob.BlobContainer) to a binary file.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-output <adams.core.io.PlaceholderFile> (property: outputFile)
    The name of the output file.
    default: ${CWD}
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.io.PlaceholderFile	m_OutputFile	the output file.

Fields inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_Input, m_LoggingPrefix, m_Owner, m_Stopped, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
BinaryFileWriter()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
void	defineOptions()	Adds options to the internal list of options.
protected String	doTransmit()	Performs the actual transmission.
protected adams.core.io.PlaceholderFile	getDefaultOutputFile()	Returns the default output file.
adams.core.io.PlaceholderFile	getOutputFile()	Get output file.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	outputFileTipText()	Returns the tip text for this property.
void	setOutputFile(adams.core.io.PlaceholderFile value)	Set output file.

Methods inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

backupState, canInput, check, cleanUp, configureLogger, doWait, findVariables, getAdditionalInformation, getFullName, getOwner, getQueue, getVariables, handleException, initialize, initTransmission, input, isBackedUp, isStopped, pruneBackup, pruneBackup, restoreState, setOwner, setUp, shallowCopy, shallowCopy, stopExecution, transmit, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_OutputFile

protected adams.core.io.PlaceholderFile m_OutputFile

the output file.

Constructor Detail

BinaryFileWriter

public BinaryFileWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

getDefaultOutputFile

protected adams.core.io.PlaceholderFile getDefaultOutputFile()

Returns the default output file.

Returns:

the file

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRatOutput

Returns:

null if no info available, otherwise short string

setOutputFile

public void setOutputFile(adams.core.io.PlaceholderFile value)

Set output file.

Specified by:

setOutputFile in interface adams.core.io.FileWriter

Parameters:

value - file

getOutputFile

public adams.core.io.PlaceholderFile getOutputFile()

Get output file.

Specified by:

getOutputFile in interface adams.core.io.FileWriter

Returns:

file

outputFileTipText

public String outputFileTipText()

Returns the tip text for this property.

Specified by:

outputFileTipText in interface adams.core.io.FileWriter

Returns:

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface RatOutput

Specified by:

accepts in class AbstractRatOutput

Returns:

doTransmit

protected String doTransmit()

Performs the actual transmission.

Specified by:

doTransmit in class AbstractRatOutput

Returns:

null if successful, otherwise error message