Package com.inductiveautomation.ignition.gateway.images

Interface ImageManager

  • public interface ImageManager

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void copyImage​(java.lang.String from, java.lang.String dest)  
      void deleteImage​(java.lang.String path)  
      ImageRecord getImage​(java.lang.String path)  
      java.util.List<ImageRecord> getImages​(java.lang.String dir)
      Returns a list of images at the given folder, without their BLOB data.
      void insertImage​(java.lang.String name, java.lang.String desc, ImageFormat type, java.lang.String dir, byte[] input, int width, int height, int size)  
      void insertImageFolder​(java.lang.String name, java.lang.String dir)
      Inserts a new image folder.

    • Method Detail

      • copyImage

        void copyImage​(java.lang.String from,
               java.lang.String dest)
        throws java.lang.Exception
        Throws:
        java.lang.Exception

      • deleteImage

        void deleteImage​(java.lang.String path)
          throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getImages

        java.util.List<ImageRecord> getImages​(java.lang.String dir)
        Returns a list of images at the given folder, without their BLOB data.

      • insertImage

        void insertImage​(java.lang.String name,
                 java.lang.String desc,
                 ImageFormat type,
                 java.lang.String dir,
                 byte[] input,
                 int width,
                 int height,
                 int size)
          throws java.sql.SQLException
        Throws:
        java.sql.SQLException

      • getImage

        ImageRecord getImage​(java.lang.String path)

      • insertImageFolder

        void insertImageFolder​(java.lang.String name,
                       java.lang.String dir)
                throws java.sql.SQLException
        Inserts a new image folder.
        Parameters:
        name - The name of the folder (not a path)
        dir - The path of the parent folder, or null for the root folder.
        Throws:
        java.sql.SQLException