FileDataCollection.m

Go to the documentation of this file.

namespace data{


/* (Autoinserted by mtoc++)
 * This source code has been filtered by the mtoc++ executable,
 * which generates code that can be processed by the doxygen documentation tool.
 *
 * On the other hand, it can neither be interpreted by MATLAB, nor can it be compiled with a C++ compiler.
 * Except for the comments, the function bodies of your M-file functions are untouched.
 * Consequently, the FILTER_SOURCE_FILES doxygen switch (default in our Doxyfile.template) will produce
 * attached source files that are highly readable by humans.
 *
 * Additionally, links in the doxygen generated documentation to the source code of functions and class members refer to
 * the correct locations in the source code browser.
 * However, the line numbers most likely do not correspond to the line numbers in the original MATLAB source files.
 */

class FileDataCollection
  :public data.FileData {
    private:

        hm;
    public:

        KeepFiles = false;
    public:

        FileDataCollection(data_dir) {
            if ~usejava(" jvm ")
                error(" FileDataCollection cannot be used as java is not enabled. ");
            end
            if nargin < 1
                data_dir = fullfile(KerMor.App.TempDirectory,...
                    sprintf(" temp_fdc_%s ",...
                    IDGenerator.generateID));
            end
            this = this@data.FileData(data_dir);
            this.hm= java.util.HashMap;
            this.clear;
        }
        function  delete() {
            if (~this.KeepFiles && ~this.isSaved) || this.hm.size == 0
                this.clear;
            end
            /*  Superclass delete removes the folder if empty. */
            delete@data.FileData(this);
        }
        function structdata = getData(rowvec<double> keydata,varargin) {
            key = Utils.getHash(keydata);
            data = [];
            if this.hm.containsKey(key)
                try
                    data = load(this.getfile(this.hm.get(key)), varargin[:]);
                catch ME
                    warning(" KerMor:FileDataCollection ",...
                        " Error loading a file from directory %s: %s ",...
                        this.DataDirectory,ME.message);
                    data = [];
                end
            else
                /*  "Backup" function. In case some data is stored and then the
                 * FileDataCollection is not saved, the existing trajectory files are recognized
                 * and loaded. */
                file = fullfile(this.DataDirectory,[key " .mat "]);
                if exist(file," file ") == 2
                    data = load(file,varargin[:]);
                    this.hm.put(key,[key " .mat "]);
                end
            end
        }
        function n = getCollectionSize() {
           n = this.hm.size;
        }


        function structdata = getDataNr(nr,varargin) {
            if nr > this.hm.size || nr < 1
                error(" Invalid data position number: %d ",nr);
            end
            keys = this.hm.keySet.toArray(java_array(" java.lang.String ",1));
            data = load(this.getfile(this.hm.get(keys(nr))), varargin[:]);
        }
        function res = hasData(keydata) {
            key = Utils.getHash(keydata);
            /*  Check in hash first */
            res = this.hm.containsKey(key);
            /*  Lazy check for file existence if not in hashmap but on disk */
            res = res || exist(fullfile(this.DataDirectory,[key " .mat "])," file ") == 2;
        }


        function  addData(keydata,data) {
            key = Utils.getHash(keydata);
            file = [key " .mat "];
            this.hm.put(key,file);

            file = fullfile(this.DataDirectory,file);
            try
                fn = fieldnames(data);
                save(file," -struct "," data ",fn[:]);
            catch ME
                this.hm.remove(key);
                rethrow(ME);
            end
        }


        function  clear() {
            ks = this.hm.values.iterator;
            while ks.hasNext
                try
                    file = this.getfile(ks.next);
                catch ME
                    warning(" KerMor:data:FileDataCollection ",...
                        " Could not delete file '%s': %s\nPlease remove manually. ",...
                        file,ME.message);
                end
                delete(file);
            end
            this.hm.clear;
        }

   
    protected: /* ( Static ) */

        static function this = loadobj(this,initfrom) {
            created = false;
            if ~isa(this, " data.FileDataCollection ")
                initfrom = this;
                this = data.FileDataCollection(initfrom.DataDirectory);
                created = true;
            end
            if nargin == 2 || created
                this.hm= initfrom.hm;
                this = loadobj@data.FileData(this, initfrom);
            else
               this = loadobj@data.FileData(this);
            end
        }

    
    public: /* ( Static ) */

        static function res = test_FileDataCollection() {
            res = true;
            thedir = fullfile(KerMor.App.TempDirectory," testFDC ");
            c = data.FileDataCollection(thedir);
            num = 10;
            keys = rand(num,1);

            for k=1:num
                s.field= rand(200,300);
                c.addData(keys(k),s);
            end
            clear c;

            if exist(thedir," file ") ~= 0
                res = false;
            end

            c = data.FileDataCollection(thedir);
            for k=1:num
                s.field= rand(500,500);
                c.addData(keys(k),s);
            end
            save(fullfile(thedir," tmpsave.mat ")," c ");
            clear c;            
            if exist(thedir," file ") ~= 7
                res = false;
            end
            rmdir(thedir," s ");
        }
};
}