cz.cuni.amis.pogamut.base.communication.translator.impl

Class WorldMessageTranslator

java.lang.Object

cz.cuni.amis.pogamut.base.communication.translator.impl.WorldMessageTranslator

All Implemented Interfaces:

IWorldChangeEventOutput, IComponent

public class WorldMessageTranslator
extends Object
implements IWorldChangeEventOutput

Abstract class for translators between world messages (InfoObjects) and IWorldEvents. It implements IWorldEventOutput interface meaning it can be given to the mediator as the source for IWorldEvents. It is constructed with parser that should provide parsed messages (translated text messages from the world to the java object wrappers) + IWorldMessageHandler that is given those parsed messages to produce IWorldEvents. It should process those messages into IWorldEvents and return them.

Ignores IComponentControlHelper.startPaused(), performs IComponentControlHelper.start() in both start cases.

Author:

Jimmy

Field Summary

Fields

Modifier and Type	Field and Description
static cz.cuni.amis.utils.token.Token	COMPONENT_ID
protected IWorldMessageTranslator	handler
protected LogCategory	log
protected IWorldMessageParser	parser Parser of the world messages, may be used to get additional messages.

Constructor Summary

Constructors

Constructor and Description
WorldMessageTranslator(IWorldMessageParser parser, IWorldMessageTranslator messageHandler, IComponentBus eventBus, IAgentLogger logger)

Method Summary

Methods

Modifier and Type	Method and Description
cz.cuni.amis.utils.token.Token	getComponentId() Unique identification of the component.
IWorldChangeEvent	getEvent() Returns next event of the world.
Logger	getLog()
protected IWorldChangeEvent[]	processMessage(InfoMessage message) Method for translating messages into events.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_ID

public static final cz.cuni.amis.utils.token.Token COMPONENT_ID

parser

protected IWorldMessageParser parser

Parser of the world messages, may be used to get additional messages.

log

protected LogCategory log

handler

protected IWorldMessageTranslator handler

Constructor Detail

WorldMessageTranslator

@Inject
public WorldMessageTranslator(IWorldMessageParser parser,
                             IWorldMessageTranslator messageHandler,
                             IComponentBus eventBus,
                             IAgentLogger logger)

Method Detail

getComponentId

public cz.cuni.amis.utils.token.Token getComponentId()

Description copied from interface: IComponent

Unique identification of the component.

Specified by:

getComponentId in interface IComponent

Returns:

getLog

public Logger getLog()

processMessage

protected IWorldChangeEvent[] processMessage(InfoMessage message)
                                      throws TranslatorException

Method for translating messages into events.

Parameters:

message -

Returns:

Throws:

WorldMessageHandlerException

TranslatorException

getEvent

public IWorldChangeEvent getEvent()
                           throws ComponentNotRunningException,
                                  ComponentPausedException

Description copied from interface: IWorldChangeEventOutput

Returns next event of the world.

May block.

Specified by:

getEvent in interface IWorldChangeEventOutput

Returns:

Throws:

ComponentNotRunningException

ComponentPausedException

toString

public String toString()

Overrides:

toString in class Object