guarana.toolkit.task.streamdealers.codecs
Class Decoder

java.lang.Object
  extended by guarana.util.observer.smart.SmartObservable
      extended by guarana.framework.task.Task
          extended by guarana.toolkit.task.streamdealers.StreamDealer
              extended by guarana.toolkit.task.streamdealers.codecs.Codec
                  extended by guarana.toolkit.task.streamdealers.codecs.Decoder
All Implemented Interfaces:
ISource, guarana.util.observer.smart.ISmartObserver

public class Decoder
extends Codec

Decodes an inbound message body from one format to another according to the codec used. See guarana.toolkit.task.streamdealers.codecs package for supported codecs. Please note that to create your own decoder you just have to implement the ICodec interface. This task does not add or remove content from the inbound messages, it keeps all the original content. For this reason the outbound message has the same MESSAGE_ID the inbound message has.

Graphical notation:


This is an Integration Pattern implementation

Problem:

Solution:

Details:

Since:
Guaranį SDK 1.0.0
Author:
Rafael Z. Frantz

Field Summary
 
Fields inherited from class guarana.framework.task.Task
input, output
 
Constructor Summary
Decoder(String name, ICodec codec)
          Constructs a new decoder task.
Decoder(String name, int numberOfInputs, int numberOfOutputs, ICodec codec)
          Constructs a new decoder task.
 
Method Summary
 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

Decoder

public Decoder(String name,
               ICodec codec)
Constructs a new decoder task.

Parameters:
name - The name of this task.
codec - The codec this task must use.

Decoder

public Decoder(String name,
               int numberOfInputs,
               int numberOfOutputs,
               ICodec codec)
Constructs a new decoder 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.
codec - The codec this task must use.
Method Detail

doWork

public void doWork(Exchange exchange)
            throws TaskExecutionException
This method implements the business logic of this task.
Decodes the body of the inbound message.

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