Package adams.flow.webservice

Class AbstractWebServiceClientSourceWithCallableTransformer<O>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.webservice.AbstractWebServiceClientSource<O>

adams.flow.webservice.AbstractWebServiceClientSourceWithCallableTransformer<O>

Type Parameters:

O - the type of the generated output data

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.ErrorProvider, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, AlternativeUrlSupporter, CallableTransformerSupport<O,O>, WebServiceClient, WebServiceClientProducer<O>, WsdlUrlProvider, Serializable

public abstract class AbstractWebServiceClientSourceWithCallableTransformer<O>
extends AbstractWebServiceClientSource<O>
implements CallableTransformerSupport<O,O>

Ancestor for webservice source clients that post-process the retrieved data with a subflow.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.flow.core.Actor	m_ActualTransformer	the actual transformer to use.
protected adams.flow.core.CallableActorReference	m_Transformer	the callable transformer.

Fields inherited from class adams.flow.webservice.AbstractWebServiceClientSource

m_AlternativeURL, m_ConnectionTimeout, m_InInterceptor, m_LastError, m_Owner, m_ReceiveTimeout, m_ResponseData, m_ResponseDataListeners, m_UseAlternativeURL

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractWebServiceClientSourceWithCallableTransformer()

Method Summary

Modifier and Type	Method	Description
O	applyTransformer(O data)	Applies the transformer to the data.
void	defineOptions()	Adds options to the internal list of options.
adams.flow.core.CallableActorReference	getTransformer()	Returns the callable transformer in use.
protected void	preQuery()	Hook method before querying the webservice.
void	setTransformer(adams.flow.core.CallableActorReference value)	Sets the callable transformer to use.
String	transformerTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.webservice.AbstractWebServiceClientSource

addResponseDataListener, alternativeURLTipText, cleanUp, connectionTimeoutTipText, doQuery, getAdditionalInformation, getAlternativeURL, getConnectionTimeout, getDefaultAlternativeURL, getDefaultInInterceptor, getInInterceptor, getLastError, getOwner, getQuickInfo, getReceiveTimeout, getResponseData, getUseAlternativeURL, getWsdlLocation, hasLastError, hasResponseData, inInterceptorTipText, initialize, notifyResponseDataListeners, postQuery, query, receiveTimeoutTipText, removeResponseDataListener, setAlternativeURL, setConnectionTimeout, setInInterceptor, setOwner, setReceiveTimeout, setResponseData, setUseAlternativeURL, useAlternativeURLTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.webservice.WebServiceClientProducer

generates

Field Detail

m_Transformer

protected adams.flow.core.CallableActorReference m_Transformer

the callable transformer.

m_ActualTransformer

protected adams.flow.core.Actor m_ActualTransformer

the actual transformer to use.

Constructor Detail

AbstractWebServiceClientSourceWithCallableTransformer

public AbstractWebServiceClientSourceWithCallableTransformer()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractWebServiceClientSource<O>

setTransformer

public void setTransformer(adams.flow.core.CallableActorReference value)

Sets the callable transformer to use.

Specified by:

setTransformer in interface CallableTransformerSupport<O,O>

Parameters:

value - the reference

getTransformer

public adams.flow.core.CallableActorReference getTransformer()

Returns the callable transformer in use.

Specified by:

getTransformer in interface CallableTransformerSupport<O,O>

Returns:

the reference

transformerTipText

public String transformerTipText()

Returns the tip text for this property.

Specified by:

transformerTipText in interface CallableTransformerSupport<O,O>

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

preQuery

protected void preQuery()
                 throws Exception

Hook method before querying the webservice.

Tries to obtain and initialize the callable transformer.

Overrides:

preQuery in class AbstractWebServiceClientSource<O>

Throws:

Exception - if it fails for some reason

applyTransformer

public O applyTransformer(O data)
                   throws Exception

Applies the transformer to the data.

Specified by:

applyTransformer in interface CallableTransformerSupport<O,O>

Parameters:

data - the data to process

Returns:

the processed data

Throws:

Exception - if it fails for some reason