guarana.toolkit.task.transformers
Class Translator

java.lang.Object
  extended by guarana.util.observer.smart.SmartObservable
      extended by guarana.framework.task.Task
          extended by guarana.toolkit.task.transformers.Transformer
              extended by guarana.toolkit.task.transformers.Translator
All Implemented Interfaces:
ISource, guarana.util.observer.smart.ISmartObserver

public abstract class Translator
extends Transformer

Transforms the body of an inbound message from one schema into another and publish an outbound message to the output gateway. All header from the inbound message is kept to the outbound message. The outbound message has a new MESSAGE_ID and the inbound message as its parent.

Graphical notation:


This is an Integration Pattern implementation

Problem: How can systems using different data formats communicate with each other using messaging?

Solution: Use a special filter, a Message Translator, between other filters or applications to translate one data format into another.

Details:

Since:
Guaranį SDK 1.0.0
Author:
Rafael Z. Frantz
See Also:
Message Translator pattern by Gregor Hohpe and Bobby Woolf for more details.

Field Summary
 
Fields inherited from class guarana.framework.task.Task
input, output
 
Constructor Summary
Translator(String name)
          Constructs a new translator task.
Translator(String name, int numberOfInputs, int numberOfOutputs)
          Constructs a new translator task.
 
Method Summary
abstract  void doWork(Exchange exchange)
          This method implements the business logic of this task.
 void update(guarana.util.observer.smart.SmartObservable slot, Object arg)
          This method is automatically called by the observable slot to notify the slot has received a message.
 
Methods inherited from class guarana.framework.task.Task
execute, getName, getTriggerInterval, isTriggerTask, setName, setTriggerInterval
 
Methods inherited from class guarana.util.observer.smart.SmartObservable
addSmartObserver, containsSmartObserver, containsSmartObserver, countSmartObservers, deleteSmartObserver, deleteSmartObservers, hasChanged, notifySmartObservers, notifySmartObservers
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Translator

public Translator(String name)
Constructs a new translator task.

Parameters:
name - The name of the translator task.

Translator

public Translator(String name,
                  int numberOfInputs,
                  int numberOfOutputs)
Constructs a new translator task.

Parameters:
name - The name of this task.
numberOfInputs - The number of input gateways this task must have.
numberOfOutputs - The number of output gateways this task must have.
Method Detail

doWork

public abstract void doWork(Exchange exchange)
                     throws TaskExecutionException
This method implements the business logic of this task.
Translates an inbound message body content into another format keeping all the original data.

Overrides:
doWork in class Task
Parameters:
exchange - An exchange object that holds the inbound messages of this task.
Throws:
TaskExecutionException - to report any exception that has occurred during the execution of this method.

update

public void update(guarana.util.observer.smart.SmartObservable slot,
                   Object arg)
This method is automatically called by the observable slot to notify the slot has received a message. For all those tasks that can execute with one or more messages in its input slots, this method will add the task to the executable task reporter, so it can be executed. In this case the task execution will consume messages from all input slots.
Please, do not call this method by yourself. Overrides the implementation at Task for performance reasons.

Specified by:
update in interface guarana.util.observer.smart.ISmartObserver
Overrides:
update in class Task
Parameters:
slot - The Slot associated with this task.
arg - THIS PARAMETHER IS NOT USED.


Guaranį DSL Home