Package adams.flow.rest

Class DeleteSpectrum

  • 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 DeleteSpectrum
extends adams.flow.rest.AbstractRESTPluginWithDatabaseConnection
    REST plugin for deleting spectra.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      DeleteSpectrum()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String delete​(String id, String format)
      Deletes the specified spectrum.
      String globalInfo()
      Returns a string describing the object.

      • 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, defineOptions, 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

    • Constructor Detail

      • DeleteSpectrum

        public DeleteSpectrum()

    • 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

      • delete

        @GET
@Path("/spectrum/delete/{id}/{format}")
@Produces("text/plain")
public String delete​(@PathParam("id")
                     String id,
                     @PathParam("format")
                     String format)
        Deletes the specified spectrum.
        Parameters:
        id - the sample ID
        format - the format, eg NIR
        Returns:
        true/false if deletion was successful, or message if spectrum did not exist