Package adams.flow.source.pyrosource

Class AbstractPyroSource

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractPyroCall

adams.flow.source.pyrosource.AbstractPyroSource

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, FlowContextHandler, PyroCall, PyroOutputProducer, Serializable

Direct Known Subclasses:

Generic, Null

public abstract class AbstractPyroSource
extends AbstractPyroCall
implements PyroOutputProducer

Ancestor for Pyro calls that generate output.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	m_Output	the generated output object.

Fields inherited from class adams.flow.core.AbstractPyroCall

m_FlowContext, m_MethodName, m_NameServer, m_RemoteObject, m_RemoteObjectName

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

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
Object	output()	Returns the generated object.
protected String	preExecute()	Before performing the actual call.

Methods inherited from class adams.flow.core.AbstractPyroCall

defineOptions, doExecute, execute, getDefaultMethodName, getDefaultRemoteObjectName, getFlowContext, getMethodName, getQuickInfo, getRemoteObjectName, methodNameTipText, postExecute, remoteObjectNameTipText, reset, setFlowContext, setMethodName, setRemoteObjectName, setUp

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, 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.Destroyable

destroy

Methods inherited from interface adams.flow.core.FlowContextHandler

getFlowContext, setFlowContext

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.core.PyroCall

execute, getMethodName, getRemoteObjectName, methodNameTipText, remoteObjectNameTipText, setMethodName, setRemoteObjectName, setUp

Methods inherited from interface adams.flow.core.PyroOutputProducer

generates

Field Detail

m_Output

protected Object m_Output

the generated output object.

Constructor Detail

AbstractPyroSource

public AbstractPyroSource()

Method Detail

preExecute

protected String preExecute()

Before performing the actual call.

Overrides:

preExecute in class AbstractPyroCall

Returns:

null if successful, otherwise error message

output

public Object output()

Returns the generated object.

Specified by:

output in interface PyroOutputProducer

Returns:

the generated object

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface PyroOutputProducer

Returns:

true if there is pending output

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractPyroCall