Package adams.flow.webservice.text

Class Upload

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.webservice.AbstractWebServiceClientSink<adams.data.text.TextContainer>

adams.flow.webservice.text.Upload

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, WebServiceClient, WebServiceClientConsumer<adams.data.text.TextContainer>, WsdlUrlProvider, Serializable

public class Upload
extends AbstractWebServiceClientSink<adams.data.text.TextContainer>

Uploads a TextContainer.

Version:

$Revision: 2085 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.data.text.TextContainer	m_ContainerIn	input container
protected String	m_Format	the format.

Fields inherited from class adams.flow.webservice.AbstractWebServiceClientSink

m_AlternativeURL, m_ConnectionTimeout, m_LastError, m_OutInterceptor, m_Owner, m_ReceiveTimeout, 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
Upload()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the classes that are accepted input.
void	defineOptions()	Adds options to the internal list of options.
protected void	doQuery()	Performs the actual webservice query.
String	formatTipText()	Returns the tip text for this property.
String	getFormat()	Returns the text format.
URL	getWsdlLocation()	Returns the WSDL location.
String	globalInfo()	Returns a string describing the object.
void	setFormat(String value)	Sets the text format.
void	setRequestData(adams.data.text.TextContainer value)	Sets the data for the request, if any.

Methods inherited from class adams.flow.webservice.AbstractWebServiceClientSink

alternativeURLTipText, cleanUp, connectionTimeoutTipText, getAdditionalInformation, getAlternativeURL, getConnectionTimeout, getDefaultAlternativeURL, getDefaultOutInterceptor, getLastError, getOutInterceptor, getOwner, getQuickInfo, getReceiveTimeout, getUseAlternativeURL, hasLastError, outInterceptorTipText, postQuery, preQuery, query, receiveTimeoutTipText, setAlternativeURL, setConnectionTimeout, setOutInterceptor, setOwner, setReceiveTimeout, setUseAlternativeURL, useAlternativeURLTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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

Field Detail

m_ContainerIn

protected adams.data.text.TextContainer m_ContainerIn

input container

m_Format

protected String m_Format

the format.

Constructor Detail

Upload

public Upload()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

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 AbstractWebServiceClientSink<adams.data.text.TextContainer>

setFormat

public void setFormat(String value)

Sets the text format.

Parameters:

value - the format

getFormat

public String getFormat()

Returns the text format.

Returns:

the format

formatTipText

public String formatTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the classes that are accepted input.

Returns:

the classes that are accepted

getWsdlLocation

public URL getWsdlLocation()

Returns the WSDL location.

Specified by:

getWsdlLocation in interface WsdlUrlProvider

Specified by:

getWsdlLocation in class AbstractWebServiceClientSink<adams.data.text.TextContainer>

Returns:

the location

setRequestData

public void setRequestData(adams.data.text.TextContainer value)

Sets the data for the request, if any.

Parameters:

value - the request data

doQuery

protected void doQuery()
                throws Exception

Performs the actual webservice query.

Specified by:

doQuery in class AbstractWebServiceClientSink<adams.data.text.TextContainer>

Throws:

Exception - if accessing webservice fails for some reason