submarine.core
Interface Serializer

All Superinterfaces:
XMLConfigurable
All Known Subinterfaces:
SerializerWithContext
All Known Implementing Classes:
FlatFileSerializer, Identity, SubMLSerializer

public interface Serializer
extends XMLConfigurable

Cette interface est implémentée par des classes qui sont en charge dans les Channel de la conversion des messages java.lang.Object en XML et réciproquement.

Quand utiliser ? :

Un Channel utilise cette interface deux fois dans ses différentes étapes. Une première fois à la réception de l'objet java représentant le message pour le convertir en XML (serializeObject(java.lang.Object)). C'est le parsing. Une seconde fois après la transformation XSL, pour convertir le résultat XML en object (serializeXML(org.w3c.dom.Document)). C'est la sérialization.

Quand implémenter ? :

Une classe implémente cette interface pour offrir la possibilité de transformé vers et depuis XML des objects dont elle connait le contenu.


Method Summary
 org.w3c.dom.Document serializeObject(java.lang.Object obj)
          Transforme un object java en un document XML.
 java.lang.Object serializeXML(org.w3c.dom.Document doc)
          Transforme un document XML en object Java.
 
Methods inherited from interface submarine.core.XMLConfigurable
init
 

Method Detail

serializeObject

public org.w3c.dom.Document serializeObject(java.lang.Object obj)
                                     throws java.lang.Exception
Transforme un object java en un document XML.
Parameters:
obj - l'object à transformer
Returns:
org.w3c.dom.Document Le document XML résultat.
Throws:
java.lang.Exception - Une exception doit être levée si le Serializer ne sait pas transformer ce type d'objet java.

serializeXML

public java.lang.Object serializeXML(org.w3c.dom.Document doc)
                              throws java.lang.Exception
Transforme un document XML en object Java.
Parameters:
doc - Le document XML contenant les informations décrivant l'objet.
Returns:
java.lang.Object L'object Java initialisé avec le document XML.
Throws:
java.lang.Exception - Lève une exception si la syntaxe attendue pour le document XML n'est pas respectée.

Submarine project. free distribution of this software must include the opensource licence.
Guénolé de Cadoudal.