adams.flow.webservice
Class AbstractWebServiceClientTransformerWithGlobalTransformer<I,O>

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.webservice.AbstractWebServiceClientTransformer<I,O>
              adams.flow.webservice.AbstractWebServiceClientTransformerWithGlobalTransformer<I,O>

Type Parameters:

I - the type of input data to handle

O - the type of output data to handle

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, SizeOfHandler, GlobalTransformerSupport<I,O>, WebServiceClient, WebServiceClientConsumer<I>, WebServiceClientProducer<O>, Serializable

Direct Known Subclasses:

CustomersByNameGlobalTransformer

public abstract class AbstractWebServiceClientTransformerWithGlobalTransformer<I,O>
extends AbstractWebServiceClientTransformer<I,O>
implements GlobalTransformerSupport<I,O>

Ancestor for transformer webservices, which post-process the received data before passing it on.

Version:

$Revision: 5353 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected AbstractActor	m_ActualTransformer the actual transformer to use.
protected GlobalActorReference	m_Transformer the global transformer.

Fields inherited from class adams.flow.webservice.AbstractWebServiceClientTransformer

m_ConnectionTimeout, m_Owner, m_ReceiveTimeout

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

AbstractWebServiceClientTransformerWithGlobalTransformer()

Method Summary

O	applyTransformer(I data) Applies the transformer to the data.
void	defineOptions() Adds options to the internal list of options.
GlobalActorReference	getTransformer() Returns the global transformer in use.
protected void	preQuery() Hook method before querying the webservice.
void	setTransformer(GlobalActorReference value) Sets the global transformer to use.
String	transformerTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.webservice.AbstractWebServiceClientTransformer

cleanUp, connectionTimeoutTipText, doQuery, getConnectionTimeout, getOwner, getReceiveTimeout, getWsdlLocation, postQuery, query, receiveTimeoutTipText, setConnectionTimeout, setOwner, setReceiveTimeout

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, globalInfo, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.webservice.WebServiceClientConsumer

accepts, setRequestData

Methods inherited from interface adams.flow.webservice.WebServiceClientProducer

generates, getResponseData, hasResponseData

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.Destroyable

destroy

Field Detail

m_Transformer

protected GlobalActorReference m_Transformer

the global transformer.

m_ActualTransformer

protected AbstractActor m_ActualTransformer

the actual transformer to use.

Constructor Detail

AbstractWebServiceClientTransformerWithGlobalTransformer

public AbstractWebServiceClientTransformerWithGlobalTransformer()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractWebServiceClientTransformer<I,O>

setTransformer

public void setTransformer(GlobalActorReference value)

Sets the global transformer to use.

Specified by:

setTransformer in interface GlobalTransformerSupport<I,O>

Parameters:

value - the reference

getTransformer

public GlobalActorReference getTransformer()

Returns the global transformer in use.

Specified by:

getTransformer in interface GlobalTransformerSupport<I,O>

Returns:

the reference

transformerTipText

public String transformerTipText()

Returns the tip text for this property.

Specified by:

transformerTipText in interface GlobalTransformerSupport<I,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 global transformer.

Overrides:

preQuery in class AbstractWebServiceClientTransformer<I,O>

Throws:

Exception - if it fails for some reason

applyTransformer

public O applyTransformer(I data)
                   throws Exception

Applies the transformer to the data.

Specified by:

applyTransformer in interface GlobalTransformerSupport<I,O>

Parameters:

data - the data to process

Returns:

the processed data

Throws:

Exception - if it fails for some reason