Package adams.flow.standalone.rats.input

Interface RatInput

All Superinterfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.option.OptionHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback

All Known Subinterfaces:

BufferedRatInput, PollingRatInput

All Known Implementing Classes:

AbstractBufferedRatInput, AbstractMetaRatInput, AbstractPollingRatInput, AbstractRatInput, Cron, DeQueue, DirWatch, DummyCronInput, DummyInput, Exec, FileLister, IMAP, InputPolling, InputWithCallableTransformer, InputWithExternalTransformer, RedisAction, RedisSubscribe, RESTTextReception, Socket, Storage, StringToken, Subscribe, Variable, WebserviceInput, WSBlobReception, WSTextReception

public interface RatInput
extends adams.core.StoppableWithFeedback, adams.core.option.OptionHandler, adams.core.AdditionalInformationHandler

Interface for input receivers for the RATS framework.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
Class	generates()	Returns the type of data this scheme generates.
String	getFullName()	Returns the full name of the receiver.
Rat	getOwner()	Returns the actor the receiver belongs to.
boolean	getReceptionInterrupted()	Returns whether the reception was interrupted.
boolean	hasPendingOutput()	Checks whether any output can be collected.
String	initReception()	Initializes the reception.
void	interruptReception()	Interrupts the reception (eg when pausing).
boolean	isReceptionRunning()	Returns whether the reception is currently running.
boolean	isStopped()	Returns whether the receiver has been stopped.
Object	output()	Returns the received data.
String	receive()	Initiates the reception of data.
void	setOwner(Rat value)	Sets the actor the receiver belongs to.
String	setUp()	Hook method for performing checks at setup time.
void	stopExecution()	Stops the execution.

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Method Detail

getFullName

String getFullName()

Returns the full name of the receiver.

Returns:

the name

setOwner

void setOwner(Rat value)

Sets the actor the receiver belongs to.

Parameters:

value - the owner

getOwner

Rat getOwner()

Returns the actor the receiver belongs to.

Returns:

the owner

setUp

String setUp()

Hook method for performing checks at setup time.

Returns:

null if successful, otherwise error message

generates

Class generates()

Returns the type of data this scheme generates.

Returns:

the type of data

hasPendingOutput

boolean hasPendingOutput()

Checks whether any output can be collected.

Returns:

true if output available

output

Object output()

Returns the received data.

Returns:

the data

initReception

String initReception()

Initializes the reception.

Returns:

null if successfully initialized, otherwise error message

receive

String receive()

Initiates the reception of data.

Returns:

null if successful, otherwise error message

interruptReception

void interruptReception()

Interrupts the reception (eg when pausing).

getReceptionInterrupted

boolean getReceptionInterrupted()

Returns whether the reception was interrupted.

Returns:

true if interrupted

isReceptionRunning

boolean isReceptionRunning()

Returns whether the reception is currently running.

Returns:

true if running

stopExecution

void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface adams.core.Stoppable

isStopped

boolean isStopped()

Returns whether the receiver has been stopped.

Specified by:

isStopped in interface adams.core.StoppableWithFeedback

Returns:

true if stopped