Package adams.flow.source.inputstreamsource

Class AbstractInputStreamGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.inputstreamsource.AbstractInputStreamGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

FromFile, FromResource

public abstract class AbstractInputStreamGenerator
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for classes that construct input streams.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected String	check()	Hook method for checks.
protected abstract InputStream	doGenerate()	Generates the InputStream instance.
InputStream	generate()	Generates the InputStream instance.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Constructor Detail

AbstractInputStreamGenerator

public AbstractInputStreamGenerator()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected String check()

Hook method for checks.

Returns:

null if checks passed, otherwise error message

doGenerate

protected abstract InputStream doGenerate()
                                   throws Exception

Generates the InputStream instance.

Returns:

the stream

Throws:

Exception - if generation fails

generate

public InputStream generate()
                     throws Exception

Generates the InputStream instance.

Returns:

the stream

Throws:

Exception - if generation fails