Package adams.flow.rest

Class AbstractRESTPluginWithFlowContext

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.rest.AbstractRESTPlugin

adams.flow.rest.AbstractRESTPluginWithFlowContext

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.flow.core.FlowContextHandler, RESTPlugin, Serializable

Direct Known Subclasses:

AbstractCallablePipeline, AbstractCallableTransformer, AbstractParametrizedGroovyRESTPlugin, AbstractRESTPluginWithDatabaseConnection, RatControl

public abstract class AbstractRESTPluginWithFlowContext
extends AbstractRESTPlugin
implements adams.flow.core.FlowContextHandler

Ancestor for REST plugins that require a flow context.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.flow.core.Actor	m_FlowContext	the flow context.

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

Method Summary

Modifier and Type	Method	Description
adams.flow.core.Actor	getFlowContext()	Returns the flow context, if any.
void	setFlowContext(adams.flow.core.Actor value)	Sets the flow context.

Methods inherited from class adams.flow.rest.AbstractRESTPlugin

getAdditionalInformation

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.GlobalInfoSupporter

globalInfo

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Field Detail

m_FlowContext

protected adams.flow.core.Actor m_FlowContext

the flow context.

Constructor Detail

AbstractRESTPluginWithFlowContext

public AbstractRESTPluginWithFlowContext()

Method Detail

setFlowContext

public void setFlowContext(adams.flow.core.Actor value)

Sets the flow context.

Specified by:

setFlowContext in interface adams.flow.core.FlowContextHandler

Parameters:

value - the actor

getFlowContext

public adams.flow.core.Actor getFlowContext()

Returns the flow context, if any.

Specified by:

getFlowContext in interface adams.flow.core.FlowContextHandler

Returns:

the actor, null if none available