HashMapXMLMetaData.m

Go to the documentation of this file.

classdef HashMapXMLMetaData<mxberry.core.cont.ondisk.AHashMap
    
    properties (Constant,GetAccess=protected)
        XML_EXTENSION='xml';
        IGNORE_EXTENSIONS={'asv','xml~'};
        ALLOWED_EXTENSIONS={'xml'};
    end
    methods
        function self=HashMapXMLMetaData(varargin)
            import mxberry.core.cont.DiskBasedHashMap;
            import mxberry.core.throwerror;
            import mxberry.core.checkvar;
            import mxberry.core.parseparext;
            %
            [regArgList,~,storageFormat]=parseparext(varargin,...
                {'storageFormat';'verxml';...
                'isstring(x)&&ismember(x,{''verxml'',''none''})'});
            %
            if ~ismember(storageFormat,{'verxml','none'})
                throwerror('wrongInput','storage format %s unknown',...
                    storageFormat);
            end
            %
            self=self@mxberry.core.cont.ondisk.AHashMap(regArgList{:},...
                'storageFormat',storageFormat);
            %
            switch lower(self.storageFormat)
                case 'verxml'
                    self.saveFunc=...
                        @mxberry.core.cont.ondisk.HashMapXMLMetaData.saveFunc;
                    self.loadKeyFunc=@mxberry.xml.xmlload;
                    self.loadValueFunc=@mxberry.xml.xmlload;
                    self.fileExtension=self.XML_EXTENSION;
                    self.isMissingKeyBlamed=true;
                case 'none'
                    self.saveFunc=@(x,y,z,w)1;
                    self.loadKeyFunc=@(x)1;
                    self.loadValueFunc=@(x)1;
                    self.isMissingKeyBlamed=true;
                otherwise
                    throwerror('wrongInput',...
                        'storage format %s is unknown',self.storageFormat);
            end
        end
        %
    end
    methods (Access=protected, Static)
        function saveFunc(fileName,valueObjName,keyObjName,varargin)
            mxberry.xml.xmlsave(fileName,struct(...
                'valueObj',{evalin('caller',valueObjName)},...
                'keyStr',{evalin('caller',keyObjName)}),...
                'on',varargin{:},'insertTimestamp',false);
        end
    end
    methods (Access=protected)
        function [isPositive,keyStr]=checkKey(self,fileName)
            isPositive=mxberry.io.isfile(fileName);
            if (strcmp(self.fileExtension,self.XML_EXTENSION))&&(nargout<2)
                return;
            end
            if isPositive
                [isPositive,keyStr]=checkKey@mxberry.core.cont.ondisk.AHashMap(...
                    self,fileName);
            end
        end
        function putOne(self,keyStr,valueObj,varargin)
            import mxberry.core.throwwarn;
            fullFileName=self.genfullfilename(keyStr);
            try
                self.saveFunc(fullFileName,'valueObj','keyStr',varargin{:});
            catch meObj
                if mxberry.io.isfile(fullFileName)
                    delete(fullFileName);
                end
                %
                if self.isPutErrorIgnored
                    throwwarn('saveFailure',...
                        'cannot save the key value: %s',...
                        meObj.message);
                    return;
                else
                    rethrow(meObj);
                end
            end
        end
        %
        function [valueObj,metaData]=getOne(self,keyStr)
            fileName=self.getFileNameByKey(keyStr);
            [resObj,metaData]=self.loadValueFunc(fileName);
            valueObj=resObj.valueObj;
        end
    end
end