Package adams.flow.source.inputstreamsource

Class FromFile

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.inputstreamsource.AbstractInputStreamGenerator

adams.flow.source.inputstreamsource.FromFile

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class FromFile
extends AbstractInputStreamGenerator

Generates an input stream from the specified file.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_Source	the file to load.

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
FromFile()

Method Summary

Modifier and Type	Method	Description
protected String	check()	Hook method for checks.
void	defineOptions()	Adds options to the internal list of options.
protected InputStream	doGenerate()	Generates the InputStream instance.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
PlaceholderFile	getSource()	Returns the source file.
String	globalInfo()	Returns a string describing the object.
void	setSource(PlaceholderFile value)	Sets the source file.
String	sourceTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.source.inputstreamsource.AbstractInputStreamGenerator

generate

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, 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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Source

protected PlaceholderFile m_Source

the file to load.

Constructor Detail

FromFile

public FromFile()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setSource

public void setSource(PlaceholderFile value)

Sets the source file.

Parameters:

value - the file

getSource

public PlaceholderFile getSource()

Returns the source file.

Returns:

the file

sourceTipText

public String sourceTipText()

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 object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractInputStreamGenerator

Returns:

null if no info available, otherwise short string

check

protected String check()

Hook method for checks.

Overrides:

check in class AbstractInputStreamGenerator

Returns:

null if checks passed, otherwise error message

doGenerate

protected InputStream doGenerate()
                          throws Exception

Generates the InputStream instance.

Specified by:

doGenerate in class AbstractInputStreamGenerator

Returns:

the stream

Throws:

Exception - if generation fails