org.mule.umo.transformer
Interface UMOTransformer

All Superinterfaces:
Cloneable, Initialisable, UMOBaseTransformer
All Known Implementing Classes:
AbstractCompressionTransformer, AbstractEncryptionTransformer, AbstractEventAwareTransformer, AbstractEventTransformer, AbstractJmsTransformer, AbstractTransformer, AbstractXmlTransformer, AbstractXStreamTransformer, Base64Decoder, Base64Encoder, ByteArrayToHexString, ByteArrayToObject, ByteArrayToSerializable, ByteArrayToString, ChatStringToString, CreditProfileXmlToCreditProfile, DecryptionTransformer, DomDocumentToXml, EmailMessageToString, EncryptionTransformer, ErrorMessageToException, ErrorMessageToExceptionBean, EventObjectTransformer, ExceptionBeanToErrorMessage, ExceptionToString, FileToByteArray, FileToString, GetBeanProperty, GZipCompressTransformer, GZipUncompressTransformer, HexStringToByteArray, HttpClientMethodResponseToObject, HttpRequestToNameString, HttpRequestToSoapRequest, HttpResponseToString, JMSMessageToObject, JXPathExtractor, LoanQuoteRequestToCreditProfileArgs, MapLookup, MessagePropertiesTransformer, MimeMessageToRfc822ByteArray, NameStringToChatString, NoActionTransformer, ObjectArrayToString, ObjectToByteArray, ObjectToFruitLover, ObjectToHttpClientMethodRequest, ObjectToJMSMessage, ObjectToMimeMessage, ObjectToRemoteInvocationResultTransformer, ObjectToRemoteInvocationTransformer, ObjectToString, ObjectToXml, ObjectToXmppPacket, RestRequestToCustomerRequest, Rfc822ByteArraytoMimeMessage, ScriptTransformer, SerializableToByteArray, SetLendersAsRecipients, StdinToNameString, StringToByteArray, StringToEmailMessage, StringToNameString, StringToObjectArray, StringToXMLMessage, TestCompressionTransformer, UMOMessageToHttpResponse, XmlEntityDecoder, XmlEntityEncoder, XmlPrettyPrinter, XmlToDomDocument, XmlToObject, XmppPacketToObject, XsltTransformer

public interface UMOTransformer
extends UMOBaseTransformer

UMOTransformer can be chained together to covert message payloads from one object type to another.


Method Summary
 UMOTransformer getNextTransformer()
          Transformers can be chained together and invoked in a series
 Class getReturnClass()
           
 boolean isAcceptNull()
          Does this transformer allow null input?
 boolean isSourceTypeSupported(Class aClass)
          Determines if a particular source class can be handled by this transformer
 void setNextTransformer(UMOTransformer nextTransformer)
          Transformers can be chained together and invoked in a series
 void setReturnClass(Class theClass)
          Sets the expected return type for the transformed data.
 Object transform(Object src)
          Thransforms the supplied data and returns the result
 
Methods inherited from interface org.mule.umo.transformer.UMOBaseTransformer
clone, getEndpoint, getName, setEndpoint, setName
 
Methods inherited from interface org.mule.umo.lifecycle.Initialisable
initialise
 

Method Detail

isSourceTypeSupported

boolean isSourceTypeSupported(Class aClass)
Determines if a particular source class can be handled by this transformer

Parameters:
aClass - The class to check for compatability
Returns:
true if the transformer supports this types of class or false otherwise

isAcceptNull

boolean isAcceptNull()
Does this transformer allow null input?

Returns:
true if this transformer can accept null input

transform

Object transform(Object src)
                 throws TransformerException
Thransforms the supplied data and returns the result

Parameters:
src - the data to transform
Returns:
the transformed data
Throws:
TransformerException - if a error occurs transforming the data or if the expected returnClass isn't the same as the transformed data

setReturnClass

void setReturnClass(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.

Parameters:
theClass - the expected return type class

getReturnClass

Class getReturnClass()
Returns:
the exceptedreturn type

getNextTransformer

UMOTransformer getNextTransformer()
Transformers can be chained together and invoked in a series

Returns:
the next transformer to invoke after this one

setNextTransformer

void setNextTransformer(UMOTransformer nextTransformer)
Transformers can be chained together and invoked in a series

Parameters:
nextTransformer - the next transforer to invoke


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.