Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> [ transformers overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.mule.transformers
Class AbstractTransformer  

java.lang.Object
  org.mule.transformers.AbstractTransformer

All Implemented Interfaces:

java.io.Serializable, org.mule.umo.transformer.UMOTransformer

Direct Known Subclasses:

CompressionTransformer, DefaultTransformer

---

public abstract class AbstractTransformer

extends java.lang.Object

implements org.mule.umo.transformer.UMOTransformer

CompressionTransformer Is a base class for all transformers. Transformations transform one object into another. This base class provides facilities for compressing and uncompressing messages.

Version:

$Revision: 1.8 $

---

Field Summary
protected  org.mule.umo.provider.UMOConnector	connector
private static org.apache.commons.logging.Log	log           logger used by this class
protected  java.lang.String	name
protected  java.util.HashMap	props
protected  java.lang.Class	returnClass
private  java.util.List	sourceTypes
static java.lang.String	TRANSFORMER_DEFAULT           The fully qualified class name of the fallback Transformer implementation class to use, if no other can be found.
protected  SingleTransformerSession	transformerSession
static java.lang.String	USE_MANAGER_PROPERTIES           Specifies that the transformer properties should be obtained from the Mule Manager properties

 

Fields inherited from interface org.mule.umo.transformer.UMOTransformer

SERVICE_ID

 

Constructor Summary

AbstractTransformer()           default constructor required for discovery

 

Method Summary
protected  java.lang.Object	checkReturnClass(java.lang.Object object)
java.lang.Object	commitSession()           Ends a session keeping the most recent transformation
abstract  java.lang.Object	doTransform(java.lang.Object src)
org.mule.umo.provider.UMOConnector	getConnector()
java.lang.String	getName()
java.util.HashMap	getProperties()
java.lang.Class	getReturnClass()
protected  java.util.Iterator	getSourceTypeClassesIterator()
boolean	isInSession()
boolean	isSourceTypeSupported(java.lang.Class aClass)
abstract  void	processProperties()           A template method to allow deriving classes to do something with their properties once the setProperties method is invoked
protected  void	registerSourceType(java.lang.Class aClass)
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 string)
void	setProperties(java.util.HashMap props)
void	setReturnClass(java.lang.Class newClass)           Sets the expected return type for the transformed data.
void	startSession()           Starts a transformer session.
java.lang.Object	transform(java.lang.Object src)           Transforms the object.
protected  void	unregisterSourceType(java.lang.Class aClass)

 

Methods inherited from class java.lang.Object

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

 

Field Detail

TRANSFORMER_DEFAULT

public static final java.lang.String TRANSFORMER_DEFAULT

The fully qualified class name of the fallback Transformer implementation class to use, if no other can be found.

See Also:

Constant Field Values

---

USE_MANAGER_PROPERTIES

public static final java.lang.String USE_MANAGER_PROPERTIES

Specifies that the transformer properties should be obtained from the Mule Manager properties

See Also:

Constant Field Values

---

log

private static transient org.apache.commons.logging.Log log

logger used by this class

---

returnClass

protected java.lang.Class returnClass

---

props

protected java.util.HashMap props

---

name

protected java.lang.String name

---

connector

protected org.mule.umo.provider.UMOConnector connector

---

transformerSession

protected SingleTransformerSession transformerSession

---

sourceTypes

private java.util.List sourceTypes

Constructor Detail

AbstractTransformer

public AbstractTransformer()

default constructor required for discovery

Method Detail

checkReturnClass

protected java.lang.Object checkReturnClass(java.lang.Object object)
                                     throws org.mule.umo.transformer.TransformerException

---

registerSourceType

protected void registerSourceType(java.lang.Class aClass)

---

unregisterSourceType

protected void unregisterSourceType(java.lang.Class aClass)

---

getSourceTypeClassesIterator

protected java.util.Iterator getSourceTypeClassesIterator()

---

getProperties

public java.util.HashMap getProperties()

Specified by:

getProperties in interface org.mule.umo.transformer.UMOTransformer

---

setProperties

public void setProperties(java.util.HashMap props)
                   throws org.mule.umo.transformer.TransformerException

Specified by:

setProperties in interface org.mule.umo.transformer.UMOTransformer

---

getName

public java.lang.String getName()

Specified by:

getName in interface org.mule.umo.transformer.UMOTransformer

---

setName

public void setName(java.lang.String string)

Specified by:

setName in interface org.mule.umo.transformer.UMOTransformer

---

getReturnClass

public java.lang.Class getReturnClass()

Specified by:

getReturnClass in interface org.mule.umo.transformer.UMOTransformer

---

setReturnClass

public void setReturnClass(java.lang.Class newClass)

Description copied from interface: org.mule.umo.transformer.UMOTransformer

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

Specified by:

setReturnClass in interface org.mule.umo.transformer.UMOTransformer

---

isSourceTypeSupported

public boolean isSourceTypeSupported(java.lang.Class aClass)

---

sessionTransform

public java.lang.Object sessionTransform(java.lang.Object src)
                                  throws org.mule.umo.transformer.TransformerException

Description copied from interface: org.mule.umo.transformer.UMOTransformer

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

Specified by:

sessionTransform in interface org.mule.umo.transformer.UMOTransformer

---

startSession

public void startSession()
                  throws org.mule.umo.transformer.TransformerException

Description copied from interface: org.mule.umo.transformer.UMOTransformer

Starts a transformer session.

Specified by:

startSession in interface org.mule.umo.transformer.UMOTransformer

---

rollbackSession

public java.lang.Object rollbackSession()
                                 throws org.mule.umo.transformer.TransformerException

Description copied from interface: org.mule.umo.transformer.UMOTransformer

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

Specified by:

rollbackSession in interface org.mule.umo.transformer.UMOTransformer

---

commitSession

public java.lang.Object commitSession()
                               throws org.mule.umo.transformer.TransformerException

Description copied from interface: org.mule.umo.transformer.UMOTransformer

Ends a session keeping the most recent transformation

Specified by:

commitSession in interface org.mule.umo.transformer.UMOTransformer

---

isInSession

public boolean isInSession()

Specified by:

isInSession in interface org.mule.umo.transformer.UMOTransformer

---

processProperties

public abstract void processProperties()
                                throws org.mule.umo.transformer.TransformerException

A template method to allow deriving classes to do something with their properties once the setProperties method is invoked

---

transform

public java.lang.Object transform(java.lang.Object src)
                           throws org.mule.umo.transformer.TransformerException

Transforms the object.

Specified by:

transform in interface org.mule.umo.transformer.UMOTransformer

---

getConnector

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

Specified by:

getConnector in interface org.mule.umo.transformer.UMOTransformer

---

setConnector

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

Specified by:

setConnector in interface org.mule.umo.transformer.UMOTransformer

---

doTransform

public abstract java.lang.Object doTransform(java.lang.Object src)
                                      throws org.mule.umo.transformer.TransformerException

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> mule >> [ transformers overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---