Package adams.flow.source.readersource

Class FromResource

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.readersource.AbstractReaderGenerator

adams.flow.source.readersource.FromResource

All Implemented Interfaces:

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

public class FromResource
extends AbstractReaderGenerator

Generates a reader from the specified resource (eg from jar).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Resource	the resource 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
FromResource()

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 Reader	doGenerate()	Generates the InputStream instance.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	getResource()	Returns the resource to load.
String	globalInfo()	Returns a string describing the object.
String	resourceTipText()	Returns the tip text for this property.
void	setResource(String value)	Sets the resource to load.

Methods inherited from class adams.flow.source.readersource.AbstractReaderGenerator

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_Resource

protected String m_Resource

the resource to load.

Constructor Detail

FromResource

public FromResource()

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

setResource

public void setResource(String value)

Sets the resource to load.

Parameters:

value - the resource

getResource

public String getResource()

Returns the resource to load.

Returns:

the resource

resourceTipText

public String resourceTipText()

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 AbstractReaderGenerator

Returns:

null if no info available, otherwise short string

check

protected String check()

Hook method for checks.

Overrides:

check in class AbstractReaderGenerator

Returns:

null if checks passed, otherwise error message

doGenerate

protected Reader doGenerate()
                     throws Exception

Generates the InputStream instance.

Specified by:

doGenerate in class AbstractReaderGenerator

Returns:

the stream

Throws:

Exception - if generation fails