Package adams.flow.webservice

Class SimpleImageService

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.db.DatabaseConnectionUser, OwnedByImageServiceWS, Serializable, ImageService
    public class SimpleImageService
extends adams.core.option.AbstractOptionHandler
implements ImageService, OwnedByImageServiceWS, adams.db.DatabaseConnectionUser
    Class that implements the Image web service.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.db.AbstractDatabaseConnection m_DatabaseConnection
      the database connection.
      protected ImageServiceWS m_Owner
      web service object
      protected adams.core.io.PlaceholderDirectory m_UploadDir
      the upload directory.

      • 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
      SimpleImageService()
      Default Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected adams.db.AbstractDatabaseConnection getDatabaseConnection()
      Determines the database connection in the flow.
      ImageServiceWS getOwner()
      Returns the current owner of this webservice.
      adams.core.io.PlaceholderDirectory getUploadDir()
      Returns the directory to store the images in.
      String globalInfo()
      Returns a string for the GUI that describes this object.
      void setOwner​(ImageServiceWS value)
      Sets the owner of this webservice.
      void setUploadDir​(adams.core.io.PlaceholderDirectory value)
      Sets the directory to store the images in.
      UploadResponse upload​(UploadRequest parameters)
      Uploads an image.
      String uploadDirTipText()
      Returns the tip text for this property.

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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

    • Field Detail

      • m_DatabaseConnection

        protected adams.db.AbstractDatabaseConnection m_DatabaseConnection
        the database connection.

      • m_UploadDir

        protected adams.core.io.PlaceholderDirectory m_UploadDir
        the upload directory.

    • Constructor Detail

      • SimpleImageService

        public SimpleImageService()
        Default Constructor.

        NB: the owning webservice needs to get set before using this implemention, using the setOwner(ImageServiceWS) method.

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string for the GUI that describes this object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        the description

      • 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

      • setUploadDir

        public void setUploadDir​(adams.core.io.PlaceholderDirectory value)
        Sets the directory to store the images in.
        Parameters:
        value - the directory

      • getUploadDir

        public adams.core.io.PlaceholderDirectory getUploadDir()
        Returns the directory to store the images in.
        Returns:
        the directory

      • uploadDirTipText

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

      • getDatabaseConnection

        protected adams.db.AbstractDatabaseConnection getDatabaseConnection()
        Determines the database connection in the flow.
        Returns:
        the database connection to use