Package adams.flow.standalone.rats

Class WSMultiSpectrumReception

  • 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<adams.flow.standalone.rats.input.AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.flow.standalone.rats.input.RatInput, Serializable
    public class WSMultiSpectrumReception
extends adams.flow.standalone.rats.input.AbstractRatInput
    Uses a webservice for retrieving spectra. 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: 2090 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected List<MultiSpectrum> m_Data
      the spectrum received via webservice.
      protected int m_WaitPoll
      the waiting period in msec before polling again.
      protected adams.flow.webservice.WebServiceProvider m_WebService
      the webservice to run.

      • Fields inherited from class adams.flow.standalone.rats.input.AbstractRatInput

        m_LoggingPrefix, m_Owner, m_ReceptionInterrupted, m_ReceptionRunning, m_Stopped

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cleanUp()
      Cleans up data structures, frees up memory.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doReceive()
      Performs the actual reception of data.
      Class generates()
      Returns the type of data this scheme generates.
      protected adams.flow.webservice.WebServiceProvider getDefaultWebService()
      Returns the default webservice provider to use.
      int getWaitPoll()
      Returns the number of milli-seconds to wait before polling again whether data has arrived.
      adams.flow.webservice.WebServiceProvider getWebService()
      Returns the webservice provider in use.
      String globalInfo()
      Returns a string describing the object.
      boolean hasPendingOutput()
      Checks whether any output can be collected.
      protected void initialize()
      Initializes the members.
      Object output()
      Returns the received data.
      void setData​(MultiSpectrum value)
      For setting the data received from the webservice.
      void setWaitPoll​(int value)
      Sets the number of milli-seconds to wait before polling whether data has arrived.
      void setWebService​(adams.flow.webservice.WebServiceProvider value)
      Sets the webservice provider to use.
      void stopExecution()
      Stops the execution.
      String waitPollTipText()
      Returns the tip text for this property.
      String webServiceTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.standalone.rats.input.AbstractRatInput

        canReceive, check, configureLogger, doWait, getAdditionalInformation, getFullName, getOwner, getQueue, getQuickInfo, getReceptionInterrupted, handleException, initReception, interruptReception, isReceptionRunning, isStopped, receive, setOwner, setUp, shallowCopy, shallowCopy, updatePrefix

      • Methods inherited from class adams.core.option.AbstractOptionHandler

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

      • Methods inherited from class adams.core.logging.LoggingObject

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

        protected adams.flow.webservice.WebServiceProvider m_WebService
        the webservice to run.

      • m_WaitPoll

        protected int m_WaitPoll
        the waiting period in msec before polling again.

    • Constructor Detail

      • WSMultiSpectrumReception

        public WSMultiSpectrumReception()

    • 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 adams.core.option.AbstractOptionHandler

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.flow.standalone.rats.input.AbstractRatInput

      • getDefaultWebService

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

      • setWebService

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

      • getWebService

        public adams.flow.webservice.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.

      • setWaitPoll

        public void setWaitPoll​(int value)
        Sets the number of milli-seconds to wait before polling whether data has arrived.
        Parameters:
        value - the number of milli-seconds

      • getWaitPoll

        public int getWaitPoll()
        Returns the number of milli-seconds to wait before polling again whether data has arrived.
        Returns:
        the number of milli-seconds

      • waitPollTipText

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

      • generates

        public Class generates()
        Returns the type of data this scheme generates.
        Specified by:
        generates in interface adams.flow.standalone.rats.input.RatInput
        Specified by:
        generates in class adams.flow.standalone.rats.input.AbstractRatInput
        Returns:
        the type of data

      • setData

        public void setData​(MultiSpectrum value)
        For setting the data received from the webservice.
        Parameters:
        value - the data received

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether any output can be collected.
        Specified by:
        hasPendingOutput in interface adams.flow.standalone.rats.input.RatInput
        Specified by:
        hasPendingOutput in class adams.flow.standalone.rats.input.AbstractRatInput
        Returns:
        true if output available

      • output

        public Object output()
        Returns the received data.
        Specified by:
        output in interface adams.flow.standalone.rats.input.RatInput
        Specified by:
        output in class adams.flow.standalone.rats.input.AbstractRatInput
        Returns:
        the data

      • doReceive

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

      • stopExecution

        public void stopExecution()
        Stops the execution.
        Specified by:
        stopExecution in interface adams.flow.standalone.rats.input.RatInput
        Specified by:
        stopExecution in interface adams.core.Stoppable
        Overrides:
        stopExecution in class adams.flow.standalone.rats.input.AbstractRatInput

      • cleanUp

        public void cleanUp()
        Cleans up data structures, frees up memory.
        Specified by:
        cleanUp in interface adams.core.CleanUpHandler
        Overrides:
        cleanUp in class adams.flow.standalone.rats.input.AbstractRatInput