Package adams.flow.webservice

Class Get

  • 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, adams.flow.webservice.AlternativeUrlSupporter, adams.flow.webservice.WebServiceClient, adams.flow.webservice.WebServiceClientProducer<Spectrum>, adams.flow.webservice.WsdlUrlProvider, Serializable
    public class Get
extends adams.flow.webservice.AbstractWebServiceClientSource<Spectrum>
    Gets a spectrum.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_Format
      the spectrum format.
      protected String m_ID
      the spectrum ID.
      protected SpectralGetService m_Port
      the port instance.
      protected SpectralGetServiceService m_Service
      the service instance.

      • 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
      Get()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cleanUp()
      Cleans up the client.
      void defineOptions()
      Adds options to the internal list of options.
      protected void doQuery()
      Performs the actual webservice query.
      String formatTipText()
      Description of this option.
      Class[] generates()
      Returns the classes that this client generates.
      String getFormat()
      Returns the format of the spectrum to retrieve.
      String getID()
      Returns the ID of the spectrum to retrieve.
      URL getWsdlLocation()
      Returns the WSDL location.
      String globalInfo()
      Returns a string describing the object.
      String IDTipText()
      Description of this option.
      protected void reset()
      Resets the scheme.
      void setFormat​(String value)
      Sets the format of the spectrum to retrieve
      void setID​(String value)
      Sets the ID of the spectrum to retrieve

      • Methods inherited from class adams.flow.webservice.AbstractWebServiceClientSource

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

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

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

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

        configureLogger, 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

    • Constructor Detail

      • Get

        public Get()

    • 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.flow.webservice.AbstractWebServiceClientSource<Spectrum>

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.core.option.AbstractOptionHandler

      • setID

        public void setID​(String value)
        Sets the ID of the spectrum to retrieve
        Parameters:
        value - the ID

      • getID

        public String getID()
        Returns the ID of the spectrum to retrieve.
        Returns:
        the ID

      • IDTipText

        public String IDTipText()
        Description of this option.
        Returns:
        description of the option

      • setFormat

        public void setFormat​(String value)
        Sets the format of the spectrum to retrieve
        Parameters:
        value - the format

      • getFormat

        public String getFormat()
        Returns the format of the spectrum to retrieve.
        Returns:
        the format

      • formatTipText

        public String formatTipText()
        Description of this option.
        Returns:
        description of the option

      • generates

        public Class[] generates()
        Returns the classes that this client generates.
        Returns:
        the classes

      • getWsdlLocation

        public URL getWsdlLocation()
        Returns the WSDL location.
        Specified by:
        getWsdlLocation in interface adams.flow.webservice.WsdlUrlProvider
        Specified by:
        getWsdlLocation in class adams.flow.webservice.AbstractWebServiceClientSource<Spectrum>
        Returns:
        the location

      • doQuery

        protected void doQuery()
                throws Exception
        Performs the actual webservice query.
        Specified by:
        doQuery in class adams.flow.webservice.AbstractWebServiceClientSource<Spectrum>
        Throws:
        Exception - if accessing webservice fails for some reason

      • cleanUp

        public void cleanUp()
        Cleans up the client.
        Specified by:
        cleanUp in interface adams.core.CleanUpHandler
        Overrides:
        cleanUp in class adams.flow.webservice.AbstractWebServiceClientSource<Spectrum>