Package adams.flow.standalone.rats.input

Class WSTextReception

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, BufferedRatInput, RatInput, Serializable
    public class WSTextReception
extends AbstractBufferedRatInput
    Uses a webservice for retrieving text. Internally polls whether data has arrived. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -web-service <adams.flow.webservice.WebServiceProvider> (property: webService)
    The webservice provider to use.
    default: knir.flow.webservice.RatsServiceWS -implementation knir.flow.webservice.RatsService
 
    -wait-poll <int> (property: waitPoll)
    The number of milli-seconds to wait before polling again whether data has 
    arrived.
    default: 50
    minimum: 0
    Version:
    $Revision: 2083 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • WSTextReception

        public WSTextReception()

    • 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 AbstractBufferedRatInput

      • getDefaultWebService

        protected WebServiceProvider getDefaultWebService()
        Returns the default webservice provider to use.
        Returns:
        the default provider

      • setWebService

        public void setWebService​(WebServiceProvider value)
        Sets the webservice provider to use.
        Parameters:
        value - the provider

      • getWebService

        public WebServiceProvider getWebService()
        Returns the webservice provider in use.
        Returns:
        the provider

      • webServiceTipText

        public String webServiceTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • doReceive

        protected String doReceive()
        Performs the actual reception of data.
        Specified by:
        doReceive in class AbstractRatInput
        Returns:
        null if successful, otherwise error message