eu.semaine.components
Class Component

java.lang.Object
  java.lang.Thread
      eu.semaine.components.Component

All Implemented Interfaces:

SEMAINEMessageAvailableListener, java.lang.Runnable

Direct Known Subclasses:

BackchannelProposer, DummyActionSelection, DummyAnalyser, DummyBMLActionProposer, DummyBMLRealiser, DummyBMLRealiserAndPlayer, DummyFeatureExtractor, DummyFML2BML, DummyFMLActionProposer, DummyInterpreter, DummyVisualFML2BML, GenericTestComponent, MessageLogComponent, SemaineAudioPlayer, SpeakingAnalyser, SpeechBMLRealiser, SpeechPreprocessor, SystemManager, TestGui, TurnTakingInterpreter, UtteranceInterpreter, UtteranceProposer

public class Component
extends java.lang.Thread
implements SEMAINEMessageAvailableListener

The abstract base class for all components. Subclasses need to:

• create receivers and/or senders in their constructor;
• implement act() and/or react(SEMAINEMessage) to do something meaningful.

Author:

marc

Nested Class Summary

static class

Component.State States of components that can be reported to the system meta component.

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.UncaughtExceptionHandler

Field Summary

protected java.util.concurrent.BlockingQueue<Receiver>	inputWaiting
protected boolean	isInput
protected boolean	isOutput
protected JMSLogger	log
protected MetaMessenger	meta
protected java.util.List<Receiver>	receivers
protected java.util.List<Sender>	senders
protected Component.State	state
protected int	waitingTime

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

protected	Component(java.lang.String componentName)
protected	Component(java.lang.String componentName, boolean isInput, boolean isOutput)

Method Summary

protected void	act() Proactive actions.
protected void	customStartIO() Any custom startup code can go here.
protected boolean	exitRequested()
void	messageAvailableFrom(Receiver source) Method called from the corresponding receiver thread, to notify us that a message is available.
protected void	react(SEMAINEMessage message) Reactions to messages.
void	requestExit() Ask this component to exit as soon as possible.
void	run()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

isInput

protected boolean isInput

isOutput

protected boolean isOutput

receivers

protected java.util.List<Receiver> receivers

senders

protected java.util.List<Sender> senders

inputWaiting

protected java.util.concurrent.BlockingQueue<Receiver> inputWaiting

log

protected JMSLogger log

state

protected Component.State state

meta

protected MetaMessenger meta

waitingTime

protected int waitingTime

Constructor Detail

Component

protected Component(java.lang.String componentName)
             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

Component

protected Component(java.lang.String componentName,
                    boolean isInput,
                    boolean isOutput)
             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

Method Detail

messageAvailableFrom

public void messageAvailableFrom(Receiver source)

Method called from the corresponding receiver thread, to notify us that a message is available.

Specified by:

messageAvailableFrom in interface SEMAINEMessageAvailableListener

Parameters:

source - the receiver that has a message available.

customStartIO

protected void customStartIO()
                      throws java.lang.Exception

Any custom startup code can go here.

Throws:

java.lang.Exception - if anything goes wrong in the internal processing of the component.

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

exitRequested

protected boolean exitRequested()

requestExit

public void requestExit()

Ask this component to exit as soon as possible.

act

protected void act()
            throws java.lang.Exception

Proactive actions. This method is called every waitingTime milliseconds if no messages arrive, and after every message processing. This base implementation does nothing; subclasses should implement suitable behaviour here.

Throws:

javax.jms.JMSException - if communication with the JMS server goes wrong.

java.lang.Exception - if anything goes wrong in the internal processing of the component.

react

protected void react(SEMAINEMessage message)
              throws java.lang.Exception

Reactions to messages. This base implementation does nothing; subclasses should implement suitable behaviour here.

Throws:

javax.jms.JMSException - if communication with the JMS server goes wrong.

java.lang.Exception - if anything goes wrong in the internal processing of the component.