UMOTransformer

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> mule >> umo >> [ transformer overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.mule.umo.transformer.UMOTransformer

SOURCE |

Download org.mule.umo.transformer.UMOTransformer

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.mule.umo.transformer
Interface UMOTransformer

All Superinterfaces:: java.io.Serializable

public interface UMOTransformer
extends java.io.Serializable

UMOTransformer manages the transformation and or translation of one type of data to the other. Source data is received, then processed and returned via the transform() method.

The return Class is specifed so that the return message is validated defore it is returned.

This interface also has the provission of a Transformer session, which simply keeps a copy of the 'live' transfromed data, so that any further transformations will use this cached data. When a session is rolled back a cached copy of the source data will be returned. When the session is committed the caches are cleared. Starting a session will simply put the transfromer in session mode.

Version:: $Revision: 1.7 $

Field Summary

static java.lang.String SERVICE_ID
          JDK1.3+ 'Service Provider' specification ( http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html )

Method Summary

java.lang.Object commitSession()
          Ends a session keeping the most recent transformation

org.mule.umo.provider.UMOConnector getConnector()


java.lang.String getName()


java.util.HashMap getProperties()


java.lang.Class getReturnClass()


boolean isInSession()


java.lang.Object rollbackSession()
          Terminates a transformer session reverting the Transformer state back to how it was when the session started.

java.lang.Object sessionTransform(java.lang.Object src)
          This is a helper method that performs a transformation within a session

void setConnector(org.mule.umo.provider.UMOConnector connector)


void setName(java.lang.String newName)


void setProperties(java.util.HashMap newProperties)


void setReturnClass(java.lang.Class theClass)
          Sets the expected return type for the transformed data.

void startSession()
          Starts a transformer session.

java.lang.Object transform(java.lang.Object src)
          Thransforms the supllied data and returns the result

Field Detail

SERVICE_ID

public static final java.lang.String SERVICE_ID

JDK1.3+ 'Service Provider' specification ( http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html )

See Also:: Constant Field Values

Method Detail

transform

public java.lang.Object transform(java.lang.Object src)
                           throws TransformerException

Thransforms the supllied data and returns the result

setName

public void setName(java.lang.String newName)

getName

public java.lang.String getName()

setReturnClass

public void setReturnClass(java.lang.Class theClass)

Sets the expected return type for the transformed data. If the transformed data is not of this class type a TransformerException will be thrown.

getReturnClass

public java.lang.Class getReturnClass()

setProperties

public void setProperties(java.util.HashMap newProperties)
                   throws TransformerException

getProperties

public java.util.HashMap getProperties()

startSession

public void startSession()
                  throws TransformerException

Starts a transformer session.

rollbackSession

public java.lang.Object rollbackSession()
                                 throws TransformerException

Terminates a transformer session reverting the Transformer state back to how it was when the session started.

commitSession

public java.lang.Object commitSession()
                               throws TransformerException

Ends a session keeping the most recent transformation

sessionTransform

public java.lang.Object sessionTransform(java.lang.Object src)
                                  throws TransformerException

This is a helper method that performs a transformation within a session

isInSession

public boolean isInSession()

getConnector

public org.mule.umo.provider.UMOConnector getConnector()

setConnector

public void setConnector(org.mule.umo.provider.UMOConnector connector)