Package adams.flow.rest

Class TransformSpectrum

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.db.DatabaseConnectionUser, adams.flow.core.FlowContextHandler, adams.flow.rest.RESTPlugin, Serializable
    public class TransformSpectrum
extends adams.flow.rest.AbstractRESTPluginWithDatabaseConnection
    REST plugin for filtering spectra.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.data.filter.Filter m_Filter
      the filter to apply.

      • Fields inherited from class adams.flow.rest.AbstractRESTPluginWithDatabaseConnection

        m_DatabaseConnection

      • Fields inherited from class adams.flow.rest.AbstractRESTPluginWithFlowContext

        m_FlowContext

      • 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 defineOptions()
      Adds options to the internal list of options.
      String filterTipText()
      Returns the tip text for this property.
      adams.data.filter.Filter getFilter()
      Returns the filter in use.
      String globalInfo()
      Returns a string describing the object.
      String put​(String id, String format, String content)
      Filters the upload spectrum (in JSON format) with the filter and returns the output of the filter again (in JSON format).
      void setFilter​(adams.data.filter.Filter value)
      Sets the filter to use.

      • Methods inherited from class adams.flow.rest.AbstractRESTPluginWithDatabaseConnection

        initDatabase, reset, setFlowContext

      • Methods inherited from class adams.flow.rest.AbstractRESTPluginWithFlowContext

        getFlowContext

      • Methods inherited from class adams.flow.rest.AbstractRESTPlugin

        getAdditionalInformation

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

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

        getLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

    • Field Detail

      • m_Filter

        protected adams.data.filter.Filter m_Filter
        the filter to apply.

    • Constructor Detail

      • TransformSpectrum

        public TransformSpectrum()

    • 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

      • setFilter

        public void setFilter​(adams.data.filter.Filter value)
        Sets the filter to use.
        Parameters:
        value - the filter

      • getFilter

        public adams.data.filter.Filter getFilter()
        Returns the filter in use.
        Returns:
        the filter

      • filterTipText

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

      • put

        @POST
@Path("/spectrum/transform/{id}/{format}")
@Consumes("text/json")
@Produces("text/json")
public String put​(@PathParam("id")
                  String id,
                  @PathParam("format")
                  String format,
                  String content)
        Filters the upload spectrum (in JSON format) with the filter and returns the output of the filter again (in JSON format).
        Parameters:
        id - the sample ID
        format - the format, eg NIR
        content - the spectrum in JSON format
        Returns:
        the spectrum or error message